Você está na página 1de 4

Documentation may refer to the process of providing evidence ("to document something") or to the communicable material used to provide

such documentation (i.e. a document). Documentation may also (seldom) refer to tools aiming at identifying documents (see bibliography) or to the field of study devoted to the study of documents and bibliographies (see documentation (field)). Subfields of documentation include:

Medical documentation Technical documentation (e.g. software documentation, product specifications, data sheets, or a patent) Legal documentation (e.g. a travel document system) Administrative documentation Historical documentation

Documentation In Computer Science: The following are different types of documentations usually seen in the Computer Science field. 1. 2. 3. 4. 5. Architectural and Design documentation. Technical Documentation. User Documentation. System Documentation. Marketing Documentation.

There are various types of Documentation Tools which are available for this purpose. Documentation understood as document is any communicable material (such as text, video, audio, etc., or combination thereof) used to explain some attributes of an object, system or procedure. It is often used to mean engineering documentation or software documentation, which is usually paper books or computer readable files (such as HTML pages) that describe the structure and components, or on the other hand, operation, of a system/product. A professional whose field and work is documentation used to be termed a documentalist. Normally, documentalists are trained or have a background in both a specific subject and in the field of documentation (today information science). A person who more or less exclusively writes technical documentation is called a technical writer. Technical writers are similarly trained or have a background in technical writing, along with some knowledge of the subject(s) they are documenting. Often, though, they collaborate with subject matter experts (SMEs), such as engineers. Common types of computer hardware/software documentation include online help, FAQs, how-tos, and user guides. The term RTFM is often used colloquially in regard to such documentation, especially to computer hardware and software user guides.

A common type of software document frequently written by software engineers in the simulation industry is the SDF (software documentation folder). While developing the software for a simulator, which can range from embedded avionics devices to 3D terrain databases by way of full motion control systems, the engineer keeps a notebook detailing the development lifecycle of the project. The notebook can contain a requirements section, an interface section detailing the communication interface of the software, a notes section to detail the proof of concept attempts to track what worked or didn't work in solving certain problems, and a testing section to detail how the software will be tested to prove conformance to the requirements of the contract. The end result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known weaknesses in the design of the software. This document will allow future developers and maintainers of the trainer to come up to speed on the software design in as short a time as possible and have a documented reference when modifying code or searching for bugs. Bibliography Bibliography (from Greek , bibliographia, literally "book writing"), as a practice, is the academic study of books as physical, cultural objects; in this sense, it is also known as bibliology[1] (from Greek -, -logia). On the whole, bibliography is not concerned with the literary content of books, but rather the "bookness" of books how they were designed, edited, printed, circulated, reprinted and collected.[2] A bibliography, the product of the practice of bibliography, is a systematic list of books and other works such as journal articles. Bibliographies range from "works cited" lists at the end of books and articles to complete, independent publications. As separate works, they may be in bound volumes such as those shown on the right, or computerised bibliographic databases. A library catalog, while not referred to as a bibliography, is bibliographic in nature. Bibliographical works are almost always considered to be tertiary sources. Bibliographic works differ in the amount of detail depending on the purpose, and can be generally divided into two categories: enumerative bibliography (also called compilative, reference or systematic), which results in an overview of publications in a particular category, and analytical, or critical, bibliography, which studies the production of books.[3][4] In earlier times, bibliography mostly focused on books. Now, both categories of bibliography cover works in other formats including recordings, motion pictures and videos, graphic objects, databases, CD-ROMs[5] and websites. A bibliography is a list of writings that share a common factor: this may be a topic, a language, a period, or some other theme. The list may be comprehensive or selective. One particular instance of this is the list of sources used or considered in preparing a work, sometimes called a reference list. Citation formats vary, but an entry for a book in a bibliography usually contains the following information:

author(s) title publisher date of publication

An entry for a journal or periodical article usually contains:


author(s) article title journal title volume pages date of publication

A bibliography may be arranged by author, topic, or some other scheme. Annotated bibliographies give descriptions about how each source is useful to an author in constructing a paper or argument. These descriptions, usually a few sentences long, provide a summary of the source and describe its relevance. Reference management software may be used to keep track of references and generate bibliographies as required. Bibliographies differ from library catalogs by including only relevant items rather than all items present in a particular library. However, the catalogs of some national libraries effectively serve as national bibliographies, as the national libraries own almost all their countries' publications. The critical study of bibliography can be subdivided into descriptive (or physical), historical, and textual bibliography. Descriptive bibliography is the close examination of a book as a physical object, recording its size, format, binding, and so on, while historical bibliography takes a broader view of the context in which a book is produced, in particular, printing, publishing and bookselling. Textual bibliography is another name for textual criticism. An annotated bibliography is a bibliography that gives a summary of the research that has been done. It is still an alphabetical list of research sources. In addition to bibliographic data, an annotated bibliography provides a brief summary or annotation. Gfytxrscutfygbu The annotation usually contains a brief summary of content and a short analysis or evaluation. Depending on your assignment you may be asked to reflect, summarise, critique, evaluate or analyse the source. [1] The purpose of annotations is to provide the reader with a summary and an evaluation of the source. In order to write a successful annotation, each summary must be concise. An annotation should display the source's central idea(s) and give the reader a general idea of what the source is about. [2]

An annotation should include the complete bibliographic information for the source. It should also include some or all of the following:

An explanation about the authority and/or qualifications of the author. Scope or main purpose of the work. Any detectable bias. Intended audience and level of reading A summary comment

Você também pode gostar