-
Notifications
You must be signed in to change notification settings - Fork 0
Wiki style guide
kvantomme edited this page Aug 5, 2013
·
15 revisions
Subsections in a Wiki article start at h3
- Any content type on a WalkHub is generally written with a capital e.g. Walkthrough and Steps
- WalkHub is written in CamelCase
- Walkthrough.it is the name of the project, ".it" should always be added if you are writing about the project.
Task titles are written as active descriptions: "Creating Walkthroughs automatically" instead of "How to create a Walkthrough"
Task topics have the following sections:
- Abstract (in italic)
- Steps (ordered, or unordered list)
- Tips: optional section
- Next: the postrequisites for a task, or any task that might follow logically after the current task
- Requirements: the prerequisites for a task
- Other resources: any other documentation related to this topic, this could be internal or external references
User stories have the following sections:
- User story
- Why we need this
- Implementation suggestions
- Implementation tracking
- External resources
- Related features