Competencies: Documentation > Documentation Engineering
Documentation Engineering
Body of Knowledge
| Topic | Description | Relevance | Career Tracks |
|---|---|---|---|
Docs-as-Code |
Version control, CI/CD, pull requests, automated testing, treating docs like software. |
Critical |
Documentation Engineer, DevOps |
Documentation CI/CD |
Build pipelines, preview deployments, link checking, linting, automated publishing. |
High |
Documentation Engineer, DevOps |
Information Architecture |
Content organization, navigation design, taxonomy, findability, user journeys. |
High |
Documentation Engineer, UX Writer |
Single-Sourcing |
Content reuse, includes/partials, conditional content, output formats. |
High |
Documentation Engineer, Technical Writer |
Attribute/Variable Management |
Externalizing values, environment-specific builds, maintaining consistency. |
High |
Documentation Engineer |
Cross-Reference Management |
Internal linking, broken link detection, reference integrity, navigation. |
High |
Documentation Engineer |
Versioning Strategies |
Documentation versioning, deprecation, migration guides, branch-based versions. |
High |
Documentation Engineer |
Localization/i18n |
Translation workflows, locale management, RTL support, translation memory. |
Medium |
Documentation Engineer, Localization |
Documentation Testing |
Vale linting, link checking, example testing, accessibility, broken xref detection. |
High |
Documentation Engineer, QA |
Documentation Metrics |
Analytics, page views, search queries, feedback, content health scoring. |
Medium |
Documentation Lead, Product |
Personal Status
| Topic | Level | Evidence | Active Projects | Gaps |
|---|---|---|---|---|
Antora Build Pipeline |
Advanced |
Multi-repo Antora aggregation — antora-playbook.yml, spoke repos, Kroki diagram generation, UI bundle customization, local + remote builds |
Antora-specific — not transferable to general CI/CD roles without broader tool experience |
|
Documentation Standards |
Expert |
Authored 20+ STD-NNN standards — STD-001 (Projects), STD-005 (Change Control), STD-010 (RCA), STD-011 (Incident), STD-013 (Taxonomy); enforced via Claude Code hooks and rules |
Standards are self-imposed — no experience with enterprise documentation governance (DITA, S1000D) |
|
Partials Architecture |
Expert |
1,107 partials across domus-captures — modular content for projects, skills, education, patterns; include::partial$ pattern; single source of truth |
Architecture is self-designed — may not scale to enterprise multi-team authoring |
|
Attribute Management |
Advanced |
127 antora.yml attributes for mutable values (IPs, hostnames, ports, paths, policy names); subs=attributes+ in code blocks; never hardcode what an attribute can express |
No conditional attributes, no attribute inheritance across components |
|
Cross-References |
Expert |
Same-component xref:page.adoc[], cross-component xref:component::page.adoc[]; backlink analysis via domus-api /graph endpoint; systematic link integrity |
No automated broken-link detection in CI |
|
Documentation-as-Code |
Expert |
Entire documentation system is git-tracked, version-controlled, CI-deployed, API-queryable; domus-api exposes 3,486 files as 44 REST endpoints |
No docs-as-code in enterprise team context, no editorial workflow (review, staging, approval) |
|
Examples Architecture |
Advanced |
495 examples organized by category (backup, vault, dns, diagrams); include::example$ pattern; code >10 lines always extracted |
No automated example testing (doctest equivalent for AsciiDoc) |