Software
/
wiki
mirror of https://github.com/OpenMandrivaSoftware/wiki.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update doc/wiki-style-guide

This commit is contained in:
ru ru 2020-05-04 23:36:57 +01:00 committed by omakuta
parent 8459b24f27
commit 6450083586
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/wiki-style-guide.md
View File

@ -2,8 +2,8 @@
title: Wiki Style Guide
description:
published: true
date: 2020-04-10T19:38:39.298Z
tags:
date: 2020-05-04T22:36:55.975Z
tags: documentation, wiki
---
# Wiki Style Guide
@ -148,15 +148,6 @@ Do not start sentences with a command, package, or option name.
`CORRECT: The <code>smolt</code> package provides hardware profiling.`
In headings, always capitalize the first word regardless of the type of speech.
All subsequent words are also capitalized other than articles ("a," "an," or "the"), short prepositions ("in," "of," "for," "with," "at," "on"), or conjunctions ("and," "but," "or").
Examples:
* Avoid Using Contractions in Technical Writing
* Try to Do the Right Thing
* Find the Right Way to Say What You Mean
* The Grass is Always Greener on the Other Side of the Fence
#### Punctuation
Punctuation is a crucial component of understanding prose.