Documentation Study Guide

📖 Core Concepts Documentation – Communicable material that describes, explains, or instructs about an object, system, or procedure. Formats & Media – Can be paper, online/web, digital files, or analog media (e.g., audio tape, CD). Documentation vs. Documentation Science – The former is instructional material; the latter is the study of how information is recorded & retrieved. Technical Writer – Blends subject‑matter knowledge with writing, content‑management, and information‑architecture skills. Compliance Documentation – Formal records that codify SOPs for regulatory needs (safety, tax, financing, technical approval). Software Documentation Types – Include RFPs, requirements statements, design/specification docs, change‑management logs, UAT reports. Hardware/Service Documentation Types – Include network diagrams (logical), network maps (physical), datasheets, service catalogs/portfolios. ITIL Guidance – Recommends a centralized database of network‑inventory data as the foundation for all IT documentation. --- 📌 Must Remember Documentation = instructional material; not the same as the academic field documentation science. ISO standards exist for documentation but are often not publicly available; use other industry guides when needed. Technical writers must partner with subject‑matter experts (SMEs) to ensure accuracy. Compliance docs are mandatory for regulatory approvals; missing or outdated docs can cause legal penalties. Change‑management documents track errors, enhancements, and version history—essential for traceability. Network diagrams = logical connections; network maps = physical layout. --- 🔄 Key Processes Gather Requirements Meet SME → capture functional & non‑functional needs → produce Requirements Statement. Draft Design/Specification Translate requirements into Software Design Doc (architecture) and Functional Spec (behaviour). Collaborative Review Technical writer ↔ SME ↔ compliance officer → iterate until sign‑off. Change Management Log issue → assess impact → update Change Management Doc → version‑control entry. Network Inventory Collection (ITIL) Deploy inventory tool → auto‑collect device data → store in central DB → generate network diagrams/maps. --- 🔍 Key Comparisons Documentation vs. Documentation Science Documentation: instructional material for users. Documentation Science: scholarly study of information recording/retrieval. Technical Writer vs. SME Technical Writer: crafts clear, structured content; knows writing & IA. SME: provides deep domain knowledge; may lack writing expertise. Network Diagram vs. Network Map Diagram: logical connections (e.g., VLANs, routing). Map: physical placement of cables, racks, devices. --- ⚠️ Common Misunderstandings “All documentation is digital.” – Many regulated environments still require paper or analog copies for audit trails. “ISO standards are freely accessible.” – Many are pay‑walled or internal; rely on industry best‑practice guides when ISO text isn’t available. “Technical writers don’t need subject knowledge.” – They must have enough domain insight to ask the right questions and verify accuracy. --- 🧠 Mental Models / Intuition Documentation as a Bridge – Imagine a bridge connecting expert knowledge on one side to user action on the other; the stronger the bridge (clear, organized docs), the smoother the crossing (user success). Layered Map Analogy – Network diagram = roadmap (routes); network map = satellite view (exact terrain). Use the right layer for the problem you’re solving. --- 🚩 Exceptions & Edge Cases Regulatory environments may mandate paper copies despite a digital‑first policy. Rapid‑release software may rely on online help only; however, compliance docs still need formal version control. ISO documentation standards might be referenced but not implemented if the organization follows a different certification framework (e.g., CMMI). --- 📍 When to Use Which User Guide vs. Quick‑Reference Guide – Use a User Guide for first‑time, comprehensive learning; use a Quick‑Reference for routine tasks or cheat‑sheet style. Requirements Statement vs. Statement of Work (SOW) – Choose Requirements when defining what the system must do; choose SOW when outlining deliverables, timelines, and responsibilities for a contract. Network Diagram vs. Network Map – Use a Diagram for troubleshooting logical issues (routing loops); use a Map for physical installation or cabling work. --- 👀 Patterns to Recognize Version‑history tables → indicates a change‑management document. “Scope of Work” headings → usually part of project‑level contracts. Logical symbols (e.g., arrows, “→”) in a diagram → likely a network diagram. Tables of specs (CPU, RAM, ports) → typical datasheet. --- 🗂️ Exam Traps Choosing “Documentation Science” as the answer for “What describes how to use a product?” – Wrong; that’s Documentation, not the academic field. Assuming every ISO standard is free – Many questions will list an ISO number; remember access may be restricted. Selecting “Network Map” when the question mentions “logical connections” – The correct choice is Network Diagram. Confusing “Compliance Documentation” with “Legal Briefs.” – Compliance docs are standard operating procedures, not argumentative legal filings. ---