Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
tails
tails
Commits
9ed6fa45
Commit
9ed6fa45
authored
Aug 04, 2018
by
sajolida
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document basic style for procedures
parent
6ef72ef2
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
0 deletions
+24
-0
wiki/src/contribute/how/documentation/style_guide.mdwn
wiki/src/contribute/how/documentation/style_guide.mdwn
+24
-0
No files found.
wiki/src/contribute/how/documentation/style_guide.mdwn
View file @
9ed6fa45
...
...
@@ -48,6 +48,30 @@
And not *graphics adapters*, *graphics*, *graphical hardware*, or
*video card*.
- **procedures** (a series of steps)
- Keep the number of steps low within a procedure (for example, below
10, ideally 7). For longer procedures, split them and give each
section a title.
- Add a blank line between each step.
- Rely on the automatic numbered of Markdown and number all the steps
with `1.`
See also the *Microsoft Manual of Style: Procedures and technical
content*.
*For example*:
<pre>
1. Make sure that you are connected to the Internet.
1. Start <span class="application">Software Sources</span>.
1. Click on the <span class="guilabel">PPAs</span> button and then choose to <span class="button">Add a new PPA…</span>.
</pre>
- **network interface**, **Wi-Fi interface**
And not *card*, *device*, or *adapter*.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment