https://www.tfcmud.com/wiki/index.php?action=history&feed=atom&title=Help%3AHandbook_guidelinesHelp:Handbook guidelines - Revision history2026-04-30T16:04:59ZRevision history for this page on the wikiMediaWiki 1.36.1https://www.tfcmud.com/wiki/index.php?title=Help:Handbook_guidelines&diff=282&oldid=prevTynian: 1 revision: Import helps2011-01-10T23:24:27Z<p>1 revision: Import helps</p>
<p><b>New page</b></p><div>{{h:h|Moderator toc}}<br />
This is a page for technical aspects in creating a handbook. It is different from the [[Help:MediaWiki help policy]] stuff because this is about the templates and the technical issues in formatting handbooks.<br />
<br />
==Vision ==<br />
The intention is that the master page of any help page in a given language is on Meta, and that this can be copied without modification (hence very easily, either manually or automatically) into another wiki of the same language.<br />
=== Categories ===<br />
for admin handbook, sys-op handbook, reader handbook.. any page that has information for said group should be in that category<br />
<br />
===Sidebars ===<br />
The index page embeds a template into it, so it appears to be a normal page, the smaller lists of features are appropriate as sidebars.<br />
<br />
==Audience Factors==<br />
*Field Experience -- more experienced users know what to search for<br />
*Site Experience -- more experienced users know how the wiki is laid out<br />
*Sys Admin -- these people are running their own server<br />
*Hacker -- these people are probably sys admins, and they are digging into the code<br />
*Moderator/Sys-op -- these people have been granted special access to the website, and need to know how to delete pages and do other privileged stuff<br />
*Reader -- these people are searching for information<br />
*Editor -- these people are contributing content to the project<br />
<br />
*Time Constraints -- An audience member may not have time to look up why a choice was made, or just need to know how to solve an immediate problem.<br />
<br />
*Viewing Equipment -- Someone may need to print the content, in which long sequential guides are important...<br />
<br />
*Language -- <br />
*Learning Style -- <br />
*Problem at Hand --<br />
<br />
==Content==<br />
The '''commands''' used in the instructions given to people will remain the same, regardless of the language of the audience. Therefore the commands should make the skeleton of a page, and the language dependant content should be added as the meat of the content. -- but this comes later! we still need to content! in english even!<br />
<br />
We Shouldn't strive for full Xanadu project functionality, because that is an extremely complex issue, however we can selectively use [[w:transclusion|transclusion]] when it makes sense.<br />
<br />
Some instructions are common across procedures, and if the commands change globally, then it makes sense to have the instructions in a template.<br />
<br />
{{H:f|langs=|enname=Handbook guidelines}}</div>Tynian