Namespaces

A fundamental aspect of documentation is figuring out how to present information to readers in the most effective way. A part of that is related to the way we create and handle namespaces, a set of schemes to organize content. Here's a few examples of the most common namespace types in documentation:

By "persona"

Personas are profiles of the target audience of a certain portion of the documentation.

Hubs by personas on MediaWiki's documentation
β”œβ”€β”€ Users
β”œβ”€β”€ System Administrators
β”œβ”€β”€ Developers
β”œβ”€β”€ Translators

By action

GitHub guides
β”œβ”€β”€ Understanding the GitHub flow
β”œβ”€β”€ Getting started with GitHub Pages
β”œβ”€β”€ Forking projects
β”œβ”€β”€ Making your code citable
β”œβ”€β”€ Mastering issues
β”œβ”€β”€ Mastering Markdown
β”œβ”€β”€ Documenting your project on GitHub
MediaWiki.org landing page
β”œβ”€β”€ Set up and run MediaWiki
β”œβ”€β”€ Edit and use MediaWiki
β”œβ”€β”€ Develop and extend code
β”œβ”€β”€ Get help and contribute

By subject

GitLab user docs
β”œβ”€β”€ Overview
β”œβ”€β”€ Concepts
β”œβ”€β”€ Use cases
β”œβ”€β”€ Projects
β”œβ”€β”€ GitLab CI/CD
β”œβ”€β”€ Account
β”œβ”€β”€ Groups

By type

Clear Linux* OS documentation
β”œβ”€β”€ About
β”œβ”€β”€ Guides
β”œβ”€β”€ Tutorials 
β”œβ”€β”€ Reference 
β”œβ”€β”€ FAQ

Last updated