Download >>> https://byltly.com/281608
Information on how to format your technical documentation is scattered all over the web, but it's hard to find easy-to-remember rules that you can apply without having to stop and think. We're trying to solve that problem with "Scandocfa Per Docfa 4 12": a set of guidelines for formatting technical documentation in the industry standard, Apache OpenOffice (also known as OOo or LibreOffice). This article is broken up into four sections: headings; symbols; lists; footnotes. It first covers basic formatting conventions for headings within a document, including different types of headings, positions of headings on a page or section break, and styles. The next section covers the conventions for readability of symbols within a document, including bold, italic, subscripts and superscripts. The third section is about lists in technical documentation. Lastly is a section on formatting footnotes in technical documentation, including formatting for references in footnotes, defining the footnote number in the text, defining the footnote number in the text of a footnote reference, defining cited material within footnotes with endnotes/footnotes. Here are some guidelines that can be used when formatting any documentation or texts written with Apache OpenOffice Writer. The sections are numbered starting at 1.1. The sections are called out by their heading levels according to sections 2.3 of the "OSDOC Style Guide". The first section applies to both Ada and technical documents. The second section only applies to technical documentation. Italic is preferred as a means of highlighting words within a sentence. It is not appropriate for headings and titles; use instead the bold formatting symbol. The following symbols may be used:The following symbols may be used: The following symbols may be used:The numbers and letters for ordinal and cardinal numbers (except those listed above) may be typed in either upper case or lower case, depending on the preference of the author. For example, according to 1234(a) or 1234(a). For document references, use p. 1234(a) or p. 1234(a). You may use numbers, letters, and symbols to represent numbers. Use parentheses for negative values. For example, −2 or -2 are correct, but not - 2 or − negative 2. The apostrophe character should not be used to distinguish between singular and plural forms. Instead of writing "the defendant's files were deleted" write "the defendant files were deleted". Use the plural form if your sentence would normally use a plural noun or verb. Letters should never be formatted as superscripts or subscripts. For example, this is incorrect: H2O or H2O. The and characters should not be used. Use the HTML special characters such as for , for , and for instead.A correct page break can also be achieved by placing a non-breaking space before the section symbol. This way, a line break does not occur before the section symbol, but a page break does occur after it: This section covers footnotes and endnotes in technical documentation. cfa1e77820
Comentarios