DSST Technical Writing study notes - final

Chapters as well and occasionally even third level

Info icon This preview shows pages 5–7. Sign up to view the full content.

View Full Document Right Arrow Icon
chapters as well, and occasionally even third-level titles (subsections or B-heads ). The depth of detail in tables of contents depends on the length of the work, with longer works having less. Formal reports ( ten or more pages and being too long to put into a memo or letter) also have tables of contents. Documents of fewer than ten pages do not require tables of contents, but often have a short list of contents at the beginning. The table of contents usually appears after the title page, copyright notices, and, in technical journals, the abstract; and before any lists of tables or figures, the foreword, and the preface. Glossary – A glossary is an alphabetical list of terms in a particular domain of knowledge with the definitions for those terms. Traditionally, a glossary appears at the end of a book and includes terms within that book which are either newly introduced or at least uncommon. Glossaries begin on a new page, and appear after the appendix(es) and bibliography. Index – An index is an alphabetical list of all the major topics and sometimes subtopics in a written work. It cites the pages where each topic can be found and allows readers to find information on particular topics quickly and easily. Indexes always come at the very end of the work. An index lists the topics discussed in a document with their corresponding page numbers. For example, the index of a document on Java will list topics such as Packages, Classes, J2EE and other such items. The index helps the reader jump backwards and forwards through the document, retrieving the topic that interests them. As you have probably noticed, we have used the word topic when referring to indexes. In general, topics get indexed in a document, although you can also index other entries. Most indexes will include the following entries: Terms e.g. J2EE Phrases Symbols Subjects that spans a range of pages
Image of page 5

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full Document Right Arrow Icon
Appendix – Located at the end of a formal report, proposal, or other long document, and supplements or clarifies the information in the body of a document. A document may have more than one appendix. Appendix may refer to: In documents: Addendum, any addition to a document, such as a book or legal contract Bibliography, a systematic list of books and other works Index (publishing), a list of words or phrases with pointers to where related material can be found in a document Signatures – A signature (from Latin signare , "to sign") is a handwritten (and sometimes stylized) depiction of someone's name, nickname or even a simple "X" that a person writes on documents as a proof of identity and intent. The writer of a signature is a signatory . Similar to a handwritten signature, a signature work describes the work as readily identifying its creator. The traditional function of a signature is evidential: it is to give evidence of: 1. The provenance of the document (identity) 2. The intention (will) of an individual with regard to that document For example, the role of a signature in many consumer contracts is not solely to provide
Image of page 6
Image of page 7
This is the end of the preview. Sign up to access the rest of the document.

{[ snackBarMessage ]}

What students are saying

  • Left Quote Icon

    As a current student on this bumpy collegiate pathway, I stumbled upon Course Hero, where I can find study resources for nearly all my courses, get online help from tutors 24/7, and even share my old projects, papers, and lecture notes with other students.

    Student Picture

    Kiran Temple University Fox School of Business ‘17, Course Hero Intern

  • Left Quote Icon

    I cannot even describe how much Course Hero helped me this summer. It’s truly become something I can always rely on and help me. In the end, I was not only able to survive summer classes, but I was able to thrive thanks to Course Hero.

    Student Picture

    Dana University of Pennsylvania ‘17, Course Hero Intern

  • Left Quote Icon

    The ability to access any university’s resources through Course Hero proved invaluable in my case. I was behind on Tulane coursework and actually used UCLA’s materials to help me move forward and get everything together on time.

    Student Picture

    Jill Tulane University ‘16, Course Hero Intern