Help:Editing: Difference between revisions
imported>Samueldr m Adds universal sections section |
imported>Samueldr Adds a tentative description for a preferred tone for articles |
||
| Line 1: | Line 1: | ||
{{expansion}} | {{expansion}} | ||
== Articles tone == | |||
Use a more <em>descriptive</em> tone, where concepts and instructions are described and explained first. A <em>prescriptive</em> tone should be avoided. | |||
Here's an example: | |||
<table> | |||
<tr> | |||
<th>Prescriptive</th> | |||
<th>Descriptive</th> | |||
</tr> | |||
<tr> | |||
<td width=50% valign=top> | |||
<b>How to deal with full /boot in case of EFI</b> | |||
<p>systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub</p> | |||
</td> | |||
<td> | |||
<b>Keeping kernels/initrd on the main partition</b> | |||
<p>For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <tt>/boot/</tt> is the <tt>ESP</tt>. | |||
</p> | |||
</td> | |||
</tr> | |||
</table> | |||
On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does. | |||
== Style guide == | |||
=== Titles === | |||
* Capitalize only the first word. | |||
== Universal sections == | == Universal sections == | ||