From 9ed6fa45f01f676bedd20008b03e5c184a227927 Mon Sep 17 00:00:00 2001 From: sajolida Date: Sat, 4 Aug 2018 11:04:06 +0000 Subject: [PATCH] Document basic style for procedures --- .../how/documentation/style_guide.mdwn | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/wiki/src/contribute/how/documentation/style_guide.mdwn b/wiki/src/contribute/how/documentation/style_guide.mdwn index d5c1e69aab..155a2df212 100644 --- a/wiki/src/contribute/how/documentation/style_guide.mdwn +++ b/wiki/src/contribute/how/documentation/style_guide.mdwn @@ -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*: + +
+1. Make sure that you are connected to the Internet.
+
+1. Start Software Sources.
+
+1. Click on the PPAs button and then choose to Add a new PPA….
+
+ - **network interface**, **Wi-Fi interface** And not *card*, *device*, or *adapter*. -- GitLab