documentation - Concepts

Explore concepts tagged with "documentation"

Total concepts: 29

Concepts

Commit - A snapshot of changes in version control, representing a specific point in the project's history.
Benefits of Documenting Processes - Process documentation makes workflows easier to discover, understand, delegate, automate, review, evaluate, and improve.
Quad Pattern - A documentation pattern using four complementary document types: rules, processes, requirements, and references.
Knowledge Codification - The process of converting knowledge into structured, documented formats that can be stored, searched, and shared independently of the original knower.
Institutional Memory - The collective knowledge, experiences, and information preserved within an organization over time.
Request For Comments (RFC) - A document proposing changes or new ideas for collaborative review and feedback before implementation.
Risk Register - A structured document that records identified risks along with their analysis, treatment plans, and current status.
Standard Operating Procedure - A documented set of step-by-step instructions for carrying out routine operations consistently and efficiently.
Screenshot Driven Development - A development approach using visual screenshots as specifications and documentation for UI development.
Product Requirements Document - A document that defines the purpose, features, functionality, and behavior of a product to be built.
Team Charter - A document defining a team's purpose, goals, roles, and operating principles.
Software Requirements Specification - A comprehensive document that describes what a software system should do, including functional and non-functional requirements.
Knowledge Elicitation - Systematic techniques for extracting tacit knowledge from domain experts and converting it into explicit, documentable form.
Documentation Debt - The accumulated cost of missing, outdated, or inadequate documentation that hinders future work.
Progressive Context Disclosure - A communication and information design pattern where context and background information is revealed gradually based on need rather than provided all upfront.
Design Rationale - The documentation of the reasons behind design decisions, capturing not just what was designed but why those choices were made and what alternatives were considered.
Flowchart - A diagram representing a process or workflow using standardized shapes and connecting arrows.
Project Charter - A foundational document that formally authorizes a project and defines its scope.
Accountability Principle - The requirement that organizations not only comply with data protection rules but must also demonstrate their compliance through documentation and evidence.
Technical Writing - The practice of creating clear and precise documentation that explains complex information to specific audiences.
Self-Documenting Code - Code written so clearly that it explains itself without requiring extensive external documentation.
Context Rot - The gradual loss of contextual information over time, making past work harder to understand and utilize.
Tribal Knowledge - Undocumented information known only to specific individuals or groups within an organization.
Literate Programming - A programming paradigm that treats programs as literature by interweaving human-readable documentation with executable code.
Runbook - A documented set of procedures for routine operations, troubleshooting, and incident response.
Architecture Decision Records - A systematic method for documenting architectural and technical decisions, their context, and rationale to preserve knowledge for future maintainers.
Explicit Knowledge - Knowledge that can be easily articulated, documented, and transferred through formal language.
Document to Forget - The purpose of documentation is to free your mind from remembering—once properly recorded, information can be safely forgotten.
Me Note - A personal documentation note containing information about yourself, your health, challenges, and personal details.

← Back to all concepts