Skip to content
Snippets Groups Projects
Commit 4842e799 authored by Heather McNamee's avatar Heather McNamee
Browse files

further information about structure

parent d30c95a9
No related branches found
No related tags found
No related merge requests found
This style guide is specifically for blog posts on GitLab.com.
 
Refer to our [official documentation style guide](http://doc.gitlab.com/ce/development/doc_styleguide.html#documentation-styleguide) which covers formatting.
Loading
Loading
@@ -11,7 +10,40 @@ Table of contents
- [Formality](#formality)
- [Images](#images)
 
## <a name="markup"></a>Markup and formatting
## Philosophy
Even before writing, GitLab articles start with two things:
- A target audience. Who is this reader? What is their prior experience and main problem?
- An objective. What will the reader be able to do by following this tutorial?
Why should they continue reading?
Right from the start of the article make those things clear to the reader as
concisely as possible before the break or jump.
Be clear in the article who the audience is, what their experience is and what their
current problem is.
Use text to describe the problem the article is solving because this will aid in searching.
State the problem as the reader might experience it.
Use error messages they would have encountered.
Be clear in the objective for your article.
What will notivate the reader to continue reading the article?
What will they gain from reading the article?
## Structure
- Introduction. State the problem, audience and purpose of the article.
- `&lt;!-- more --&gt;` break
- Concepts they need to understand
- Configuration or set up required to begin the tutorial
- Tutorial broken down into steps
- Conclusion to summarize the article
If the article is part of a series, make sure to link back among all articles
in the series to each one after they get published.
## Formatting
 
See references directly in the documentation style guide. Of particular use.
 
Loading
Loading
@@ -19,7 +51,13 @@ See references directly in the documentation style guide. Of particular use.
- [Formatting text][docformatting]
- [Links in text][doclinks]
 
## <a name="person"></a>Person
In blog posts use the more comment line to mark where the jump is.
> `&lt;!-- more --&gt;`
This will break the introduction which gets displayed on the [blog listing page][blogpage].
## Person
 
Generally in blog posts, it's normal to write from first person singular point of view.
"I've found" or "I think" are common.
Loading
Loading
@@ -33,13 +71,13 @@ Use
 
> In this post we will...
 
## <a name="formality"></a>Formality
## Formality
 
GitLab tutorial blog posts should be written in a friendly style, but free of
jargon or memes.
Avoid using cultural idioms and references that could exclude or confluse readers.
 
## <a name="images"></a>Images
## Images
 
### Creating images
 
Loading
Loading
@@ -71,7 +109,7 @@ guidelines in the [Documentation style guide][docimages].
Credit where credit is due: Some of the guidelines are inspired by the
[Digital Ocean tutorial style guide][dostyleguide].
 
[blogpage]: https://about.gitlab.com/blog
[unsplash]: https://unsplash.com/
[tinypng]: https://tinypng.com/
[doctext]: http://doc.gitlab.com/ce/development/doc_styleguide.html#text
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment