ToME WikiThis page is for specific discussion among Doc folks and is not intended for generic commentary/suggestions. Generic documentation commentary and/or suggestions should be posted in WikiSuggestions or GeneralDiscussion.
Doc volunteer chatter
Do not, repeat, do not! change the Documentation portion of the wiki without checking with me, FearofFours, or MassimilianoMarangio first. Thank you. -- Maylith
First of all, the in-game documentation (which drives the wiki doc section) is pathetically out of date...but you knew that already.
Second of all, the big deal about documentation is that this doc is currently literally driving development of the in-game documentation for future versions of ToME. That means that FearofFours (and others) are looking at the wiki Documentation and indexing between the doc changelog and what has been posted so far, and making changes to the game.
Changing in-game help is a humongous, humongous pain in the proverbial, so any change to documentation is critical, and IT NEEDS TO BE LOGGED... as accurately as possible, so FearofFours can easily see the changes are and update game help as he sees fit.
Please do not, ever ever, change the doc without logging it. It's easy to forget, especially if you see a typo or other minor problem (such as a wiki link which will never appear in the in-game help), but try to watch it, and correct yourself if there's an unlogged edit. Also, please correct me or anyone else you see making the same error.
Please familiarize yourself with the ChangeLog page. At the top of the page is a general mission statement. Also, please browse through the Doc region and get a general sense of what the appearance is. TOC on top between lines, sections (usually ==) below.
All the lovely little stubs in documentation are things which I plunked there as placeholders for items from the in-game help. Some of those are going to be condensed (i.e. I made a whole bunch of placeholders when in fact they could have all gone on one page, since short little entries make stupidly short pages.) Don't arbitrarily flush out shallow links; most of the time they can all be put on one page. The stubs are just that -- placeholders.
Major thing: look out for spoilers and Pernisms. They have ZERO place in doc.
Peace... and any questions, please feel free to post and/or email me.
ReenenLaurie: Ok, and what I've learnt (the hard way), is that we document 2.2.7 at the moment. I guess as 2.3 reaches shipping, we could start making changes there (some will be major). Hopefully the 2.2.7 docs is completed before 2.3 ships, then we are set for the 'wiki'-doc evolution. 
MayLith: Yes, doc for 2.2.7 only, for now. One thing at a time. I need to get to sleep, but tomorrow I'll work on setting up an initial job list.
FearofFours: Hi thanks for this. What Maylith said basically . I'm going to be updating the docs over the next few weeks and I'm already considering moving some of the info and pages to reflect changes in the wiki.
GregSweetman: (Posted here as the policy page is rather busy at the moment)
Having read the Documentation/ChangeLog page I can certainly see the logic in recording everything, no matter how small. It helps to keep everything recorded in one place. I'll follow these guidelines to the letter.
MayLith: Thanks. Even yanking a period counts, or entering a carriage return, as it'll help poor FoF. And for that matter, importing from the in-game help leads to another entire ball of wax.... which I'll work on explaining next. Must go to the store, though -- life does go on!
BTW, if for some reason a documentation question comes up and I'm not here to answer, FearofFours' requirements take precedence over mine.
Skeleton header flag for each and every doc page
Discussion welcome; this is just a rudimentary start.
This page is part of the formal documentation for ToME.
Please do not make frivolous edits to this page. Considered contributions are welcome. However, we require that you adhere to these guidelines:
Obey WikiPolicy and the StyleGuide.
Do not post any spoilers within the documentation. Post spoilers in the SpoilerArchive.
Without fail, record your changes with exacting detail in the ChangeLog. (Link to be wikiized later.) See the header there for additional information. Sign and date your changes.
- Unlogged changes, blather, and other inappropriate changes will be reverted. Other changes may also be reverted, so save your thoughts to a file before posting if you wish to retain them permanently.