[SM-Discuss] Details and Integrity Checking Reference documentation review request
minozake at codemages.net
Fri Jul 9 17:35:52 EDT 2010
-----BEGIN PGP SIGNED MESSAGE-----
I am attempting to write reference documentation to replace the current
spell script pages for all of the files found in a script directory of a
spell. Namely, I need reviews upon it now, as I can't improve it any
more than I have it.
I opted for a general rewrite of this documentation, since editing the
currently-used pages would be a nightmare to refactor from a tutorial
type to a reference type of documentation. MoinMoin syntax likes to get
in the way.
The main things I am looking out for are:
-How is the conciseness of each part of the reference?
-Am I missing information, such as variables, explanations of what's
-Anything else that bugs you?
What you should do, any, some, or none:
-Edit the page to put in missing information or edit to style it
-Don't worry too much about Documentation Guidelines with your
-Reply to this email so I can add it (if you're lazing about :P)
-Criticize everything you feel like. Remember, though, I probably
copy and pasted this from the API, modifying it to fit the page.
The API should be blamed second, first to my not noticing it.
-Fix or email about formatting issues. MoinMoin syntax has very bad
-Have Fun. (^,^)b
Hopefully this will better the Source Mage GNU/Linux documentation in
that less people have to ask on IRC about the API, or refer to the code
itself. So far, it's gotten use out of me when I've had to edit spells,
despite only describing two parts of a spell.
Documentation pages to review are:
There shall be more pages in the coming months. All WIP pages from Tome
are present at <http://sourcemage.org/Tome/Workshop> for anyone to edit.
~Donald 'minozake' Johnson
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
-----END PGP SIGNATURE-----
More information about the SM-Discuss