Development Documentation: Difference between revisions
No edit summary |
|||
| Line 14: | Line 14: | ||
For effective branching, one should not only group different content into similar categories but also consider the navigation implications of the branches. | For effective branching, one should not only group different content into similar categories but also consider the navigation implications of the branches. | ||
Be aware of ambiguous naming within projects. Knowing when to use unique names is important; for example, "shaft coupling" versus "tractor shaft coupling" versus "tractor drive shaft coupling": use the first only if it is clear that the navigator is within the tractor project, and that there is only 1 shaft coupling to refer to within it, and be careful of future edits that bring other branches within the tractor project with the term "shaft coupling". | |||
Latest revision as of 17:19, 21 May 2012
Categorized Content
Content is organized into categories for ease of navigation and editing.
In general, categorize when the content is:
- Different
- Lengthy
Organizing Category Branches
As you continually categorize content again and again, you will end up with a branching system of content, where 1 category splits into many, many splits into many more, and so on.
For effective branching, one should not only group different content into similar categories but also consider the navigation implications of the branches.
Be aware of ambiguous naming within projects. Knowing when to use unique names is important; for example, "shaft coupling" versus "tractor shaft coupling" versus "tractor drive shaft coupling": use the first only if it is clear that the navigator is within the tractor project, and that there is only 1 shaft coupling to refer to within it, and be careful of future edits that bring other branches within the tractor project with the term "shaft coupling".