- Tutorials: technical content provided step-by-step on how to do things, or how to reach very specific objectives
- Tutorials: technical content provided step-by-step on how to do things, or how to reach very specific objectives
-**[Indexes per Topic](topics/)**: content gathering all resources already published by GitLab related to an specific subject or theme, including:
-**[Indexes per Topic](topics/)**: content gathering all resources already published by GitLab related to an specific subject or theme, including:
- General Docs
- General Docs
-Documentation Articles
-Technical Articles
- Blog Posts
- Blog Posts
- Video Tutorials
- Video Tutorials
See also:
See also:
-[Distinction between General Documentation and Documentation Articles](development/writing_documentation.md#distinction-between-general-documentation-and-documentation-articles)
-[Distinction between General Documentation and Technical Articles](development/writing_documentation.md#distinction-between-general-documentation-and-technical-articles)
- GitLab [University](university/README.md): guides to learn Git and GitLab through courses and videos.
- GitLab [University](university/README.md): guides to learn Git and GitLab through courses and videos.
@@ -27,7 +27,7 @@ The table below shows what kind of documentation goes where.
...
@@ -27,7 +27,7 @@ The table below shows what kind of documentation goes where.
| `doc/legal/` | Legal documents about contributing to GitLab. |
| `doc/legal/` | Legal documents about contributing to GitLab. |
| `doc/install/`| Probably the most visited directory, since `installation.md` is there. Ideally this should go under `doc/administration/`, but it's best to leave it as-is in order to avoid confusion (still debated though). |
| `doc/install/`| Probably the most visited directory, since `installation.md` is there. Ideally this should go under `doc/administration/`, but it's best to leave it as-is in order to avoid confusion (still debated though). |
| `doc/update/` | Same with `doc/install/`. Should be under `administration/`, but this is a well known location, better leave as-is, at least for now. |
| `doc/update/` | Same with `doc/install/`. Should be under `administration/`, but this is a well known location, better leave as-is, at least for now. |
| `doc/topics/` | Indexes per Topic (`doc/topics/topic-name/index.md`); Documentation Articles: user guides, admin guides, technical overviews, tutorials (`doc/topics/topic-name/`). |
| `doc/topics/` | Indexes per Topic (`doc/topics/topic-name/index.md`); Technical Articles: user guides, admin guides, technical overviews, tutorials (`doc/topics/topic-name/`). |
-**General Documentation**: written by the developers responsible by creating features. Should be submitted in the same merge request containing code. Feature proposals (by GitLab contributors) should also be accompanied by its respective documentation. They can be later improved by PMs and Technical Writers.
-**General Documentation**: written by the developers responsible by creating features. Should be submitted in the same merge request containing code. Feature proposals (by GitLab contributors) should also be accompanied by its respective documentation. They can be later improved by PMs and Technical Writers.
-**Documentation Articles**: written by any GitLab Team member, GitLab contributors, or Community Writers.
-**Technical Articles**: written by any GitLab Team member, GitLab contributors, or Community Writers.
-**Indexes per topic**: initially prepared by the Technical Writing Team, and kept up-to-date by developers and PMs, in the same merge request containing code.
-**Indexes per topic**: initially prepared by the Technical Writing Team, and kept up-to-date by developers and PMs, in the same merge request containing code.
## Distinction between General Documentation and Documentation Articles
## Distinction between General Documentation and Technical Articles
Every **Documentation Article** contains, in the very beginning, a blockquote with the following information:
Every **Documentation Article** contains, in the very beginning, a blockquote with the following information:
...
@@ -20,7 +20,7 @@ Every **Documentation Article** contains, in the very beginning, a blockquote wi
...
@@ -20,7 +20,7 @@ Every **Documentation Article** contains, in the very beginning, a blockquote wi
General documentation is categorized by _User_, _Admin_, and _Contributor_, and describe what that feature is, and how to use it or set it up.
General documentation is categorized by _User_, _Admin_, and _Contributor_, and describe what that feature is, and how to use it or set it up.
## Documentation Articles - Writing Method
## Technical Articles - Writing Method
Use the [writing method](https://about.gitlab.com/handbook/marketing/developer-relations/technical-writing/#writing-method) defined by the Technical Writing team.
Use the [writing method](https://about.gitlab.com/handbook/marketing/developer-relations/technical-writing/#writing-method) defined by the Technical Writing team.
