blob: 049c93809117e7bdcb831be9117cb034f941fc53 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
.Dd $Mdocdate: March 22 2009 $
.Dt "Writing Unix Documentation" paper
.Os
.Sh NAME
.Nm Writing Unix Documentation
.Nd a guide to writing Unix manuals
.Sh DESCRIPTION
<h1>
Writing Unix Documentation
</h1>
<p>
<span class="attn">A utility without documentation is of no utility at all.</span>
</p>
<p>
A system component's documentation describes the utility of that component, whether it's a device
driver, an executable or, most importantly, a game. Although there are plenty of documents available on
how to <i>read</i> Unix documents, or where to find them, few focus on how to <i>write</i> them.
</p>
<p>
This document serves as a reference guide to writing Unix documentation. If you add something to your
operating system, whether it's a new file format or directory structure or device driver, it needs
documentation.
</p>
</td>
</tr>
<tr>
<td>
<div class="foot">
Copyright © 2009 Kristaps Džonsons, $Date: 2009/03/22 08:52:27 $
</div>
</td>
</tr>
</tbody>
</table>
</body>
</html>
|