Revision as of 11:37, 9 July 2010 (view source)Annew (talk | contribs) (Draft 1) Revision as of 18:55, 10 July 2010 (view source) Annew (talk | contribs) m (moved WriteManuals to Writing an Application Manual)Newer edit → (No difference) Revision as of 18:55, 10 July 2010 Contents 1 Writing an Application Manual 1.1 Notes 1.2 Contents 1.3 Building your Manual 1.4 Preparing the Manual for Translation Writing an Application Manual Notes Manuals will be included as sub-pages of the main application page. For brevity, I will refer to that main page as Appname. The structure, therefore would be something like: Appname Appname/Hints and Tips Appname/Appname Manual # Your Contents page Appname/Appname Manual/An Introduction to Appname Appname/Appname Manual/Configuration Choices Appname/Appname Manual/The First Time you use Appname Appname/Appname Manual/section 1 Appname/Appname Manual/section xxx Appname/Appname Manual/Hints and Tips Appname/Appname Manual/Troubleshooting Appname/Appname Manual/Found a bug? Appname/Appname Manual/Get involved #link to techbase etc You will need a scratchpad to experiment with section headings/pages. You can use either your UserTalk page, or the discussion pages attached to the area where you are working. It's helpful if you remove anything no longer required, once the job is completed. Contents Once you have made the decisions (that can be a lengthy procedure), create appropriate links on the Contents page. It is, of course, possible to insert a section later if you find you've missed something. Building your Manual Use the red links to create the page, and write up a section at a time. Note on the Discussion page anything you will need to refer to later, such as links that can't yet be created. Preparing the Manual for Translation The steps for markup editing can be found on Preparing a Page for Translation. Please adhere to that guide, since old markup styles may not still be relevant. Retrieved from "https://userbase.kde.org/index.php?title=Writing_an_Application_Manual&oldid=39489" Content is available under Creative Commons License SA 4.0 unless otherwise noted.