About this documentation

This section of the NB Store Codeplex Wiki is in development - The most current documentation for each release can be viewed via the Help link on the Admin tab in the Back Office. If you have become familiar with the operation of NB Store, please consider volunteering to update the Documentation Wiki - Thanks!

Documentation Authoring guide

If you have become familiar with the operation of NB Store, please consider volunteering to update the Documentation Wiki - Thanks!
  • The documentation tab is to become the primary source of all NB Store information - the "one version of the truth". There should ultimately be very little or no documentation found on pages outside of this tab.
  • The strategy for this documentation is to assist three specific audiences in carrying out the tasks they need to do.
  • The three audiences are Host, Admin, and the Store Operator
  • The tasks will normally be presented at two levels: Basic and Advanced.
  • The basic tasks cover only the minimum steps needed for each audience to complete their part in the creation and operation of the store. This will be a step by step guide to follow rather than the more usual manner of having to interpret lists of features and functions.
  • The advanced tasks cover all tasks and settings that are optional rather than required.
  • There is also a section with general information at the start of the guide, and an appendix in the administrator's section.
  • The Store Operator's section is to be authored as a stand-alone document with the goal that it can be copied out and printed for a client with minor modification. This means it may contain some information that is also in the Admin section.
  • Release vs Beta - The documentation is always meant to cover the current stable release.
  • Beta documentation can be inserted where it belongs, but indicated with the module version number and "beta" as in (NBStore02.00.06InstallBeta17)
  • Specific troubleshooting tips will be directly placed alongside the tasks they refer to.
  • 99% of content should be plain text without any emphasis. You may use H3, Bold, Italics, bullets, and the Horizontal rule (4 dashes on a single line). Do not use underlines.
  • Use code formatting and tables as needed. Details are in the markup guide here: http://codeplex.codeplex.com/wikipage?title=Wiki%20Formatting&referringTitle=CodePlex%20Wiki%20Markup%20Guide
  • The formatting and structure of all documentation will be overseen and changes will be applied without comment. Please go by the formatting of existing articles.





Last edited Nov 25, 2010 at 10:47 AM by robax, version 7

Comments

No comments yet.