Return to manuals.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/manuals.7, Revision 1.1

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