Documentation
23 items tagged with "documentation"
Standards4
ISO/IEC 9075:1999 (SQL:1999)
The ISO/IEC standard is essential for ensuring effective and compliant software migrations, providing guidelines for risk management, data integrity, and documentation. By adhering to this standard, teams can minimize downtime, enhance security, and build trust with stakeholders, ultimately leading to more efficient migration processes.
Apache Thrift 0.16
Adhering to Apache standards during software migrations enhances interoperability, security, and efficiency. By focusing on code quality, comprehensive testing, and clear documentation, teams can ensure their migration projects align with best practices, ultimately leading to successful transitions and reduced risks.
reStructuredText 1.0
Adhering to the undefined standard from docutils is essential for ensuring clear and maintainable documentation during software migrations. This framework promotes consistency, collaboration, and accessibility, making it easier for teams to navigate the complexities of migration projects. By implementing best practices and utilizing effective tools, organizations can enhance their documentation processes and ensure successful outcomes.
ISO/IEC 15408-1:2022 (Common Criteria)
Adhering to ISO/IEC standards during software migrations is crucial for ensuring quality, mitigating risks, and meeting regulatory compliance. This comprehensive guide outlines the key requirements, practical strategies for compliance, and common challenges to help teams navigate their migration projects successfully.
Best Practices4
Architecture Decision Records (ADRs)
An Architecture Decision Record (ADR) is a short, version-controlled document that captures one significant architectural decision, its context, and its consequences for future maintainers.
C4 Model for Software Architecture
The C4 model is a lean, hierarchical way to diagram software architecture at four levels of abstraction: System Context, Containers, Components, and Code.
Documentation as Code
Documentation as Code treats docs like software: stored in version control, written in plain text, reviewed in pull requests, and published automatically through continuous integration.
Keep a Changelog
Keep a Changelog is a convention for writing human-readable, chronologically ordered changelogs grouped by change type, so users and maintainers can see what changed in each release.
Models3
Anti-Patterns5
Redundant Comments
Comments that merely restate what the code already says, adding noise, drifting out of date, and masking the absence of self-explanatory code.
Bus Factor of One
Critical knowledge or capability concentrated in a single person, so the project halts if that person becomes unavailable.
Knowledge Silos
Information and expertise trapped within individuals or teams, blocking collaboration and forcing others to rediscover what is already known.
Documentation Rot
Documentation that drifts out of sync with the system it describes, becoming stale and misleading until teams learn to distrust it entirely.
Inconsistent API Naming and Conventions
An API where naming, casing, pluralization, error formats, and conventions vary across endpoints, raising the learning curve and integration errors.
Benchmarks2
Glossaries2
OpenAPI
OpenAPI is a language-agnostic specification for describing HTTP APIs in a machine-readable document, enabling shared contracts, documentation, and code generation.
Postmortem
A written, blameless analysis produced after an incident that documents what happened, the impact, the root causes, and the actions to prevent recurrence.