Author Topic: I would like to offer my text editing/composition services to devs...  (Read 987 times)

Timepilot2084 (OP)

  • *
  • Posts: 35
    • Facebook Page
While most programmers are quite capable of doing it themselves, I'd like to offer my services as a text proofreader or even in the formulation of software instruction manuals.  I'm excellent with spelling and punctuation, and nothing detracts from a great piece of software like misspellings or incorrect grammar-especially those for in which English was a second language for its creator.  I'd be happy to take a look at software and write a user's manual to include in OPK's.  Not all apps have them, and it seems a shame to waste this capability.  It isn't much, but that's what I'm best at.  And I want to contribute to the great Zero community.
Timepilot2084
timepilot2084 AT gmail.com
@rob_conder

Nebuleon

  • Guest
As I just wrote in the unified emulator menu button thread, I don't think developers are keen on creating documentation that will just not be read, instead just answering users' questions as they come up. I think the other way: making manuals for applications makes sense because you never know when or where your users will get stuck in the future, and they might not be able to ask you, or you might not be available.

You could help create manuals or proofread manuals that users create for their favourite applications. That would be a good use of your proofreading abilities.

I offer the PocketSNES, ReGBA and Hocoslamfy manuals as templates:

https://github.com/Nebuleon/PocketSNES/blob/master/data/manual-en.txt

https://github.com/Nebuleon/ReGBA/blob/master/source/opendingux/data/manual-en.txt

https://github.com/Nebuleon/hocoslamfy/blob/master/data/manual-en.txt

Emulator port documentation should include at least how to get the emulator's files and directories set up before the first run (in cases like ReGBA which can use a GBA BIOS you provide, or MAME4ALL and FBA which have ROM directories to set up with a certain ROM set), how to set your default game directory and select a ROM, re-enter the menu, exit the emulator, switch games, and explain button bindings and options in decent detail. This would allow a user who forgot all about how he or she set up an emulator, but lost data or something, to set the emulator up again with minimum fuss.

Some game engine ports with copyrighted data files, like eduke32, have a screen in which they tell users what files to put where before aborting if they don't find the files. That's good too, but a manual with button bindings would be even better.

Timepilot2084 (OP)

  • *
  • Posts: 35
    • Facebook Page
I noticed your post in the button thread-and I see your point.  The last thing you wanna do after working on code is spend another day writing a manual that won't be read, then get asked a million questions (that have been answered if they'd only RTFM) on the release thread.  And thanks for the templates-maintaining commonality among all emulator's manuals would be desirable.  I'm prepared to do what it takes!
Timepilot2084
timepilot2084 AT gmail.com
@rob_conder

Aeter

  • *
  • Posts: 322
Manuals are always beneficial.
I say all opk app/emulator coders should take advantage of this while the offer is still on the table.
~cucullus non facit monachum~

jxv

  • *
  • Posts: 38
The wiki could always use more help. Message Surkow if you're interested.