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.
βββ Users
βββ System Administrators
βββ Developers
βββ Translators
By action
βββ Understanding the GitHub flow
βββ Getting started with GitHub Pages
βββ Forking projects
βββ Making your code citable
βββ Mastering issues
βββ Mastering Markdown
βββ Documenting your project on GitHub
βββ Set up and run MediaWiki
βββ Edit and use MediaWiki
βββ Develop and extend code
βββ Get help and contribute
By subject
βββ Overview
βββ Concepts
βββ Use cases
βββ Projects
βββ GitLab CI/CD
βββ Account
βββ Groups
By type
βββ About
βββ Guides
βββ Tutorials
βββ Reference
βββ FAQ
Last updated