summaryrefslogtreecommitdiffstats
path: root/manuals.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-03-22 08:52:27 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-03-22 08:52:27 +0000
commitcf2c069b38b257059a2eeb84c38a24fe86c715bb (patch)
treedb50035ba542eb38d08802615355a076feef30d1 /manuals.7
parenta9d3d4288c2b573605a81c6fccba5e9ce61f6d1d (diff)
downloadmandoc-cf2c069b38b257059a2eeb84c38a24fe86c715bb.tar.gz
More documentation clarification.
Diffstat (limited to 'manuals.7')
-rw-r--r--manuals.739
1 files changed, 39 insertions, 0 deletions
diff --git a/manuals.7 b/manuals.7
new file mode 100644
index 00000000..1f98a905
--- /dev/null
+++ b/manuals.7
@@ -0,0 +1,39 @@
+.Dd $Mdocdate$
+.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 &#169; 2009 Kristaps D&#382;onsons, $Date$
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </body>
+</html>