Wiki Patterns

Patterns for successful wiki use

User Tools

Site Tools


naming_conventions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
naming_conventions [2018/11/14 22:14]
127.0.0.1 external edit
naming_conventions [2018/11/28 15:01] (current)
splitbrain Struct data changed
Line 1: Line 1:
-===== Naming Conventions =====+====== Naming Conventions ======
  
 Too much variation in how pages are named in a wiki can lead to pages being hard to remember and find, so it's useful to develop a basic naming convention so things stay organised as the wiki grows. Too much variation in how pages are named in a wiki can lead to pages being hard to remember and find, so it's useful to develop a basic naming convention so things stay organised as the wiki grows.
  
-==== Usage ====+===== Usage =====
  
 A given structure makes it easier to remember names. When links are listed in alphabetical order, the documents belonging to the same type can be grouped easily. Introduce naming conventions. As a minimum, documents should start with the name of the template they are derived from, followed by the title, and possibly the initials of the responsible author: DocumentType_<SpeakingTitle>_[Initials]. The speaking title should use a singular form. A given structure makes it easier to remember names. When links are listed in alphabetical order, the documents belonging to the same type can be grouped easily. Introduce naming conventions. As a minimum, documents should start with the name of the template they are derived from, followed by the title, and possibly the initials of the responsible author: DocumentType_<SpeakingTitle>_[Initials]. The speaking title should use a singular form.
  
-==== Example ====+===== Example =====
  
 This site groups patterns by type - People Patterns, People anti-Patterns, Content Patterns, and Content anti-Patterns. By labeling pages, the site can display alphabetically ordered lists of each type, as seen at the bottom of this and all other pages. This site groups patterns by type - People Patterns, People anti-Patterns, Content Patterns, and Content anti-Patterns. By labeling pages, the site can display alphabetically ordered lists of each type, as seen at the bottom of this and all other pages.
  
-==== Related Patterns ====+===== Related Patterns =====
  
-  * [[CamelCase|CamelCase]] +  * [[CamelCase]] 
-  * [[Social+Tagging|Social Tagging]]+  * [[Social Tagging]]
  
-==== Further Reading ==== +===== Further Reading =====
- +
-  * This contribution was initially taken from Using Wikis to Manage Use Cases: Experience and Outlook, page 113 of  [[http://www.se.uni-hannover.de/big_picture/LSOplusRE-Proceedings-web-v1.0.pdf|Proceedings of Workshop on Learning Software Organizations and Requirements Engineering\]] +
  
 +  * This contribution was initially taken from Using Wikis to Manage Use Cases: Experience and Outlook, page 113 of  [[http://www.se.uni-hannover.de/events/LSOplusRE/LSOplusRE-Proceedings-web-v1.0.pdf|Proceedings of Workshop on Learning Software Organizations and Requirements Engineering\]] 
  
  
 ---- struct data ---- ---- struct data ----
 +classification.type  : Pattern
 +classification.focus : Adoption
 ---- ----
  
naming_conventions.1542230057.txt.gz · Last modified: 2018/11/14 22:14 by 127.0.0.1