WordNet

documentary validation; "his documentation of the results was excellent"; "the strongest support for this view is the work of Jones" (同)support
confirmation that some fact or statement is true through the use of documentary evidence (同)certification, corroboration
observe with care or pay close attention to; "Take note of this chemical reaction" (同)take note, observe
a promise to pay a specified amount on demand or at a certain time; "I had to co-sign his note at the bank" (同)promissory_note, note of hand
a characteristic emotional quality; "it ended on a sour note"; "there was a note of gaiety in her manner"; "he detected a note of sarcasm"
a comment or instruction (usually added); "his notes were appended at the end of the article"; "he added a short notation to the address on the envelope" (同)annotation, notation
a notation representing the pitch and duration of a musical sound; "the singer held the note too long" (同)musical note, tone
a short personal letter; "drop me a line when you get there" (同)short letter, line, billet
a brief written record; "he made a note of the appointment"
a tone of voice that shows what the speaker is feeling; "there was a note of uncertainty in his voice"
make mention of; "She observed that his presentation took up too much time"; "They noted that it was a fine day to go sailing" (同)observe, mention, remark
make a written note of; "she noted everything the teacher said that morning" (同)take_down
the act of creating written works; "writing was a form of therapy for him"; "it was a matter of disputed authorship" (同)authorship, composition, penning
the activity of putting something in written form; "she did the thinking while he did the writing" (同)committal to writing
the work of a writer; anything expressed in letters of the alphabet (especially when considered from the point of view of style and effect); "the writing in her novels is excellent"; "that editorial was a fine piece of writing" (同)written material, piece of writing
(usually plural) the collected work of an author; "the idea occurs with increasing frequency in Hemingways writings"
letters or symbols that are written or imprinted on a surface to represent the sounds or words of a language; "he turned the paper over so the writing wouldnt show"; "the doctors writing was illegible"
support or supply with references; "Can you document your claims?"
a written account of ownership or obligation
anything serving as a representation of a persons thinking by means of symbolic marks
writing that provides information (especially information of an official nature) (同)written document, papers
record in detail; "The parents documented every step of their childs development"
a statement that represents something in words (同)verbal description
sort or variety; "every description of book was there"
the act of describing something
give a description of; "He drew an elaborate plan of attack" (同)depict, draw
program listings or technical manuals describing the operation and use of programs (同)documentation

PrepTutorEJDIC

文書調べ,文書による証拠固め / 資料,証拠書類
〈C〉《複数形で》『覚え書き』,控え,メモ / 〈C〉(本文に対する)『注』,駐釈 / 〈C〉(形式ばらない)『短い手紙』,短信;外交上の文書 / 〈U〉『注目』,注意 / 〈U〉『重要性』(importance);顕著 / 〈C〉《単数形で》(声の)調子,(感情などの)しるし,兆候《+『of』+『名』》 / =promissory note / 〈C〉『紙幣』 / 〈C〉音楽;音符;(ピアノなどの)けん / …‘を'『書き留める』,記す / …‘に'『注意する』;…Iと'気づく / (取り立てて)…‘に'ついて言う,‘を'習す
〈U〉『書くこと』 / 〈U〉筆跡,書掛 / 〈U〉(口頭に対して)書かれて形式,文書 / 〈U〉〈C〉『書かれたもの』(手紙,書類,銘など) / 《複数形で》文学作品,著作 / 〈U〉著述業,文筆業
(証書・記録・資料などの)『文書』,書類 / …‘を'事実(証拠)で裏づける
〈U〉〈C〉(…の)『記述』,『描写』《+『of』+『名』》 / 〈C〉人相書き,人相 / 〈C〉種類,銘柄
…‘を'『描写する』,‘の'特徴を述べる / 〈図形など〉‘を'『描く』,‘の'輪郭をかく

Wikipedia preview

出典(authority):フリー百科事典『ウィキペディア（Wikipedia）』「2016/02/19 16:39:41」(JST)

wiki en

[Wiki en表示]

The multi-volume user guide to a 1975 programming language called CB UNIX

Documentation is a set of documents provided on paper, or online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, on-line help, quick-reference guides. It is becoming less common to see paper (hard-copy) documentation. Documentation is distributed via websites, software products, and other on-line applications.

Professionals educated in this field are termed documentalists. This field changed its name to information science in 1968, but some uses of the term documentation still exists and there have been efforts to reintroduce the term documentation as a field of study.

1 Principles for producing documentation
- 1.1 Guidelines
- 1.2 Procedures and techniques
2 Producing documentation
- 2.1 Specializing documentation
- 2.2 Indexing
3 Documentation in computer science
- 3.1 Tools for documenting software
4 Documentation in criminal justice
5 Notes
6 See also
7 External links

Principles for producing documentation

While associated ISO standards are not easily available publicly, a guide from other sources for this topic may serve the purpose. ^[1]^, ^[2]^,.^[3] David Berger has provided several principles of document writing, regarding the terms used, procedure numbering and even lengths of sentences, etc.^[4]

Guidelines

The following is a list of guides dealing with each specific field and type:

documentation in health care ^[5]
thesis writing [6], [7], [8]
papers for academic journal publishing (i.e. Journal of Food Science ^[9] and Analytical Chemistry ^[10])

Procedures and techniques

The procedures of documentation vary from one sector, or one type, to another. In general, these may involve document drafting, formatting, submitting, reviewing, approving, distributing, reposting and tracking, etc., and are convened by associated SOPs in a regulatory industry. Documentation should be easy to read and understand. If it's too long and too wordy, it may be misunderstood or ignored. Clear, Short, Familiar words should be used to a maximum of 15 words to a sentence. Only gender hyper neutral word should be used and cultural biases should be avoided. Procedures should be numbered when they are to be performed. ^[11]^, ^[12]^, ^[13]^,.^[14]

Producing documentation

Technical writers and corporate communicators are professionals whose field and work is documentation. Ideally, technical writers have a background in both the subject matter and also in writing and managing content (information architecture). Technical writers more commonly collaborate with subject matter experts (SMEs), such as engineers, medical professionals, or other types of clients to define and then create content (documentation) that meets the user's needs. Corporate communications includes other types of written documentation that is required for most companies.

Specializing documentation

Marketing Communications (MarCom): MarCom writers endeavor to convey the company's value proposition through a variety of print, electronic, and social media. This area of corporate writing is often engaged in responding to proposals.
Technical Communication (TechCom): Technical writers document a company's project or service. Technical publication include user guides, installation manuals, and troubleshooting/repair/replace procedures.
Legal Writing: This type of documentation is often prepared by attorneys or paralegals who could be in private practice or retained as corporate council.
Compliance documentation: This type of documentation codifies Standard Operating Procedures (SOPs), for any regulatory compliance needs, as for safety approval, taxation, financing, technical approval, etc.

Indexing

Index (database)
Index (search engine)

Documentation in computer science

The following are typical software documentation types

Request for Proposal (RFP)
Requirements/ Statement of work/ Scope of Work (SOW)
Software Design and Functional Specification
System Design and Functional Specifications
Change Management, Error and Enhancement Tracking
User Acceptance Testing

The following are typical hardware and service documentation types

network diagrams
network maps
datasheet for IT systems (Server, Switch, e.g.)
Service Catalog and Service Portfolio (ITIL)

Documentation include such as feasibility report, technical documentation, operational documentation, log book, etc.

Tools for documenting software

There are many types of software and applications used to create documentation.

SOFTWARE DOCUMENTATION FOLDER (SDF)

A common type of software document written by software engineers in the simulation industry is the SDF. When developing 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 "the build" of the project or module. The document can be a wiki page, MS word document or other environment. They should contain a requirements section, an interface section to detail the communication interface of the software. Often a notes section is used to detail the proof of concept, and then track errors and enhancements. Finally, a testing section to document how the software was tested. This documents conformance to the client's requirements. The 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 defects and work-arounds. This build document enables future developers and maintainers to come up to speed on the software in a timely manner, and also provides a roadmap to modifying code or searching for bugs.

SOFTWARE FOR NETWORK INVENTORY AND CONFIGURATION (CMDB)

These software tools can automatically collect data of your network equipment. The data could be for inventory and for configuration information. The ITIL Library requests to create such a database as a basis for all information for the IT responsible. It's also the basis for IT documentation.

Documentation in criminal justice

"Documentation" is the preferred term for the process of populating criminal databases. Examples include the National Counter-terrorism Center's Terrorist Identities Datamart Environment ("TIDE"), sex offender registries, and gang databases.^[15]

Notes

^ N/A (2003). "Guide to Documentation" (PDF). ^{[dead link]}
^ CGRP. "A Guide to Documentation Styles" (PDF). Retrieved 12 June 2009.
^ N/A. "A guide to MLA documentation" (PDF). Retrieved 12 June 2009. ^{[dead link]}
^ Berger, David. "Procedures and Documentation" (PDF). Retrieved 15 June 2009.
^ Springhouse. Complete Guide to Documentation. Retrieved 12 June 2009.
^ Tampere University of Technology. "Thesis Writing at the Tampere University of Technology" (PDF). Retrieved 12 June 2009.
^ Faculty of Veterinary Medicine, University of Prince Edward Island. "A Guide for the Writing of Graduate Theses" (PDF). Retrieved 12 June 2009.
^ University of Waikato. "Writing and Submitting a Dissertation or Thesis at the University of Waikato" (PDF). Retrieved 12 June 2009.
^ Journal of Food Science. "Manuscript Submission". Retrieved 12 June 2009.
^ Analytical Chemistry. "Information for Authors". Retrieved 12 June 2009.
^ Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Retrieved 15 June 2009.
^ N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Retrieved 15 June 2009. ^{[dead link]}
^ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Retrieved 15 June 2009.
^ UK Data Archive. "Data Services Process Guides: Documentation Processing Techniques" (PDF). Retrieved 15 June 2009. ^{[dead link]}
^ Rader Brown, Rebecca (2009). "The Gang's All Here: Evaluating the Need for a National Gang Database". Columbia Journal of Law and Social Problems 42: 293–333.

External links

IEEE Professional Communication Society
Documentation Definition by The Linux Information Project (LINFO)
Information & Documentation List of selected tools

Library of articles on documentation: Technical writing and documentation articles

UpToDate Contents

全文を閲覧するには購読必要です。 To read the full text you will need to subscribe.

1. インフォームドコンセント informed consent
2. 婦人科外科手術を受ける女性の術前評価および準備 preoperative evaluation and preparation of women for gynecologic surgery
3. 病院における水痘の予防および管理 prevention and control of varicella in hospitals
4. 末梢神経ブロックの概要 overview of peripheral nerve blocks

English Journal

A workflow task force affects emergency physician compliance for point-of-care ultrasound documentation and billing.

Lewiss RE1, Cook J2, Sauler A3, Avitabile N4, Kaban NL5, Rabrich J3, Saul T3, Siadecki SD3, Wiener D6.
Critical ultrasound journal.Crit Ultrasound J.2016 Dec;8(1):5. doi: 10.1186/s13089-016-0041-0. Epub 2016 May 20.
BACKGROUND: Emergency point-of-care ultrasound (POC u/s) is an example of a health information technology that improves patient care and time to correct diagnosis. POC u/s examinations should be documented, as they comprise an integral component of physician decision making. Incomplete documentation
PMID 27207087

Barriers to hand hygiene in ophthalmic outpatients in Uganda: a mixed methods approach.

Mearkle R1, Houghton R2, Bwonya D3, Lindfield R1.
Journal of ophthalmic inflammation and infection.J Ophthalmic Inflamm Infect.2016 Dec;6(1):11. doi: 10.1186/s12348-016-0077-0. Epub 2016 Mar 17.
BACKGROUND: Healthcare-associated infection rates are high in low-income countries and are associated with significant morbidity. There is a paucity of published data on infection control practice, attitudes or resources in these settings, particularly in ophthalmology. The aim of this study is to u
PMID 26984441

Improvement of blood pressure control and physicians' management over time in patients with coronary artery disease.

Hägglund O1, Sjöqvist I1, Linde C2, Svensson P1, Östergren J1.
Blood pressure.Blood Press.2016 Oct;25(5):286-91. doi: 10.1080/13102818.2016.1172846. Epub 2016 Apr 22.
BACKGROUND: Patients with coronary artery disease (CAD) are at high risk for secondary CV events. Few studies have been performed concerning the physicians' reactions to high BP in patients with manifest CAD.AIMS: To compare the prevalence and management of high BP after percutaneous coronary interv
PMID 27104916

The validity and reliability of the Thai version of the Kujala score for patients with patellofemoral pain syndrome.

Apivatgaroon A1, Angthong C1, Sanguanjit P1, Chernchujit B1.
Disability and rehabilitation.Disabil Rehabil.2016 Oct;38(21):2161-4. doi: 10.3109/09638288.2015.1114035. Epub 2016 Jan 5.
PURPOSE: To develop a Thai version of the Kujala score and show the evaluation of the validity and reliability of the score.METHOD: The Thai version of the Kujala score was developed using the forward-backward translation protocol. The 49 PFPS patients answered the Thai version of questionnaires inc
PMID 26729626