Skill-Profil

Documentation as Code

Markdown, AsciiDoc, documentation pipelines, review process, site generation

Version Control & Collaboration Collaboration Tools

Rollen

18

wo dieser Skill vorkommt

Stufen

5

strukturierter Entwicklungspfad

Pflichtanforderungen

35

die anderen 51 optional

Domäne

Version Control & Collaboration

skills.group

Collaboration Tools

Zuletzt aktualisiert

17.3.2026

Verwendung

Wählen Sie Ihr aktuelles Level und vergleichen Sie die Erwartungen.

Was wird auf jedem Level erwartet

Die Tabelle zeigt, wie die Tiefe von Junior bis Principal wächst.

Rolle Pflicht Beschreibung
Analytics Engineer Documents dbt models in YAML: model and column descriptions, tags for categorization. Follows team templates for doc blocks. Maintains README with dbt project structure description and instructions for new team members.
Backend Developer (C#/.NET) Writes documentation for C#: XML doc comments, README files. Generates docs via DocFX.
Backend Developer (Go) Writes Go documentation: godoc comments, README files, code examples. Understands godoc conventions.
Backend Developer (Java/Kotlin) Writes Java documentation: Javadoc comments, README files. Generates docs via Maven javadoc plugin.
Backend Developer (Node.js) Writes documentation in code: JSDoc/TSDoc comments, README files, API examples. Generates docs via TypeDoc.
Backend Developer (Python) Writes Python documentation: docstrings (Google/NumPy style), README files. Generates docs via Sphinx.
Backend Developer (Rust) Writes documentation in code: Rust doc comments (///), README.md, examples in doc tests. Understands cargo doc generation.
Cloud Engineer Understands docs-as-code principles: Markdown/AsciiDoc, version-controlled documentation alongside infrastructure code. Can write runbooks and operational procedures in Git-managed repositories. Follows team conventions for README files and architecture decision records (ADRs).
DevOps Engineer Understands documentation as code principle: documentation in Git alongside code. Writes README for infrastructure repositories, creates simple runbooks in Markdown. Knows Markdown basics, uses templates for documentation.
Infrastructure Engineer Documents infrastructure components in docs-as-code format: README.md for Terraform modules with input/output descriptions, basic runbooks in Markdown for routine operations. Uses terraform-docs for module documentation auto-generation and keeps records of infrastructure decisions.
Language Tooling Engineer Understands docs-as-code principles for language tooling projects: grammar documentation, parser behavior specs, and API references in version-controlled formats. Writes documentation alongside compiler/LSP code changes. Follows team standards for technical documentation.
QA Engineer (Manual) Understands docs-as-code principles for test documentation: test plans, test cases, and checklists in Markdown/Git. Maintains test documentation alongside source code in version control. Follows team conventions for organizing and updating QA documentation.
QA Security Engineer Documents security findings: vulnerability reports, test results, security checklists in Markdown. Follows documentation templates.
Release Engineer Knows basic documentation-as-code concepts for release engineering and can apply them in typical tasks. Uses standard tools and follows established team practices. Understands when and why this approach is applied.
Technical Writer Pflicht Understands the documentation-as-code principle: documentation stored in Git, versioned alongside code, reviewed through pull requests. Can create and edit Markdown files in a repository, submit PRs with documentation changes.
Rolle Pflicht Beschreibung
Analytics Engineer Creates comprehensive dbt project documentation: doc blocks for reusable descriptions, markdown files for business context, ERD diagrams for data models. Configures dbt docs generate and deploy for automated documentation publishing.
Backend Developer (C#/.NET) Implements docs-as-code: DocFX for API docs, Swagger/OpenAPI generation, code examples.
Backend Developer (Go) Implements docs-as-code: comprehensive godoc, OpenAPI generation, example tests as documentation.
Backend Developer (Java/Kotlin) Implements docs-as-code: comprehensive Javadoc, Spring REST Docs, AsciiDoc for guides.
Backend Developer (Node.js) Implements docs-as-code: OpenAPI generation from NestJS, TypeDoc for libraries, Docusaurus for guides. Integrates in CI.
Backend Developer (Python) Implements docs-as-code: Sphinx/MkDocs, OpenAPI generation, code examples as tests.
Backend Developer (Rust) Implements docs-as-code: comprehensive rustdoc, mdBook for guides, automated API docs generation. Integrates documentation in CI.
Cloud Engineer Documents cloud infrastructure as code: terraform-docs for automated module README generation, Architecture Decision Records (ADR) for key decisions. Maintains diagrams-as-code through Mermaid/PlantUML for network topologies and architecture diagrams.
DevOps Engineer Implements documentation as code: auto-generation from Terraform (terraform-docs), Helm (helm-docs), OpenAPI. Configures MkDocs/Docusaurus for internal documentation, CI/CD for auto-publishing. Creates architecture decision records (ADR).
Engineering Manager Implements docs-as-code practices in the team: documentation review as part of PR process, automated doc builds, and integration with CI/CD. Understands trade-offs between wiki-based and Git-based documentation. Ensures architecture decisions are captured as ADRs.
Infrastructure Engineer Creates comprehensive infrastructure documentation as code: ADR (Architecture Decision Records) for infrastructure decisions, runbooks with automatic CI validation. Generates network diagrams from Terraform through inframap, maintains inventory documentation and configures automatic publishing through MkDocs.
Language Tooling Engineer Implements docs-as-code for language tooling: auto-generated API docs from source, interactive grammar playground documentation, and versioned language specification. Uses documentation generators (TypeDoc, rustdoc, godoc) as part of build pipeline. Maintains changelog automation from commit history.
QA Engineer (Manual) Implements docs-as-code workflows for QA: test documentation auto-generated from test management tools, living test plans updated with each release, and traceability matrices in version control. Uses static site generators for test documentation portals. Automates test coverage reports as documentation artifacts.
QA Security Engineer Creates security documentation: test plans, security assessment reports, runbooks in git-managed docs. Automates report generation.
Release Engineer Confidently applies documentation-as-code for release engineering in non-standard tasks. Independently selects the optimal approach and tools. Analyzes trade-offs and proposes improvements to existing solutions.
Technical Lead Implements docs-as-code in the development workflow: documentation requirements in PR checklists, automated API reference generation (OpenAPI, GraphQL schema), and developer guides co-located with code. Establishes documentation standards for the team and ensures consistency.
Technical Writer Pflicht Fully works in docs-as-code workflow: branch, write, PR, review, merge, deploy. Configures CI/CD for automated documentation building and publishing. Uses linting (markdownlint, vale) for text quality control.
Rolle Pflicht Beschreibung
Analytics Engineer Pflicht Architects the analytics platform documentation system: integrating dbt docs with the data catalog, automated freshness and lineage documentation, business term glossary. Implements documentation-as-code with CI validation for description completeness.
Backend Developer (C#/.NET) Designs documentation strategy: living documentation, automated API docs, versioned guides.
Backend Developer (Go) Designs documentation strategy for Go services: godoc-driven API documentation, automated README generation from code comments, versioned architecture guides. Implements documentation testing (example tests as living docs). Creates runbooks and operational documentation co-located with service code. Integrates documentation builds into CI/CD pipeline.
Backend Developer (Java/Kotlin) Designs documentation strategy: living docs, Spring REST Docs automation, versioned API docs.
Backend Developer (Node.js) Designs documentation strategy: automated API docs, living documentation, versioned guides. Implements docs-as-code pipeline.
Backend Developer (Python) Designs documentation strategy for Python services: Sphinx/MkDocs-driven API documentation with autodoc, type-annotated interface references, and versioned migration guides. Implements doctest-based documentation verification. Creates comprehensive developer onboarding docs and operational runbooks co-located with service code.
Backend Developer (Rust) Designs documentation strategy: living documentation, automated architecture diagrams, versioned docs. Implements docs-as-code pipeline.
Cloud Engineer Pflicht Designs documentation-as-code for cloud platform: auto-generated architecture diagrams from Terraform state, self-documenting modules with examples, automated docs pipeline in CI. Introduces Backstage/internal developer portal with up-to-date infrastructure documentation.
DevOps Engineer Pflicht Designs documentation system for DevOps: unified portal (Backstage) with auto-generated documentation, runbooks with monitoring integration. Implements docs-as-code pipeline: automated validation, link checking, freshness alerts.
Engineering Manager Pflicht Designs documentation architecture for engineering teams: developer portals (Backstage, Docusaurus), automated doc pipelines, and documentation quality metrics. Ensures documentation coverage tracks with feature delivery. Establishes doc review processes and ownership models. Mentors team on effective technical writing.
Infrastructure Engineer Pflicht Designs infrastructure documentation system: auto-generation from IaC code (terraform-docs, ansible-doc), live architecture diagrams through Mermaid/D2, service catalog integration. Implements documentation testing (broken links, schema validation), creates postmortem templates and designs knowledge base for on-call engineers.
Language Tooling Engineer Pflicht Designs comprehensive documentation systems for language tools: interactive documentation with embedded code execution, version-aware API references, and migration guides generated from breaking change detection. Implements documentation testing (doctests) as part of CI. Mentors team on documentation architecture.
QA Engineer (Manual) Pflicht Designs documentation systems for QA processes: living quality dashboards, automated test evidence generation, and compliance documentation as code. Implements bidirectional traceability between requirements, test cases, and defects in version control. Mentors team on effective QA documentation practices.
QA Security Engineer Pflicht Designs security documentation framework: threat model docs, security architecture docs, automated evidence collection for compliance. Versions security policies.
Release Engineer Expertly applies documentation-as-code for release engineering to design complex systems. Optimizes existing solutions and prevents architectural mistakes. Conducts code reviews and trains colleagues on best practices.
Solutions Architect Pflicht Designs enterprise documentation architecture: multi-project documentation sites, cross-reference systems, and architecture documentation frameworks (C4, arc42). Implements documentation pipelines that aggregate content from multiple repositories. Creates documentation governance standards for client-facing technical deliverables.
Technical Lead Pflicht Designs documentation strategy for the product: living documentation, automated API docs from source annotations (Swagger, TypeDoc), versioned guides aligned with release cycles. Implements documentation quality gates in CI/CD. Creates architectural documentation standards (ADRs, C4 diagrams) and ensures team adoption.
Technical Writer Pflicht Designs scalable docs-as-code processes: multi-repo documentation, cross-references, automated content generation. Implements content reuse (snippets, includes, variables). Creates custom CI checks for documentation quality gates.
Rolle Pflicht Beschreibung
Analytics Engineer Pflicht Defines documentation standards for the analytics organization: mandatory descriptions for all production models, templates for new models and packages. Implements metrics and SLA for documentation coverage, automatic reminders for undocumented models.
Backend Developer (C#/.NET) Defines documentation standards: mandatory XML docs, review process, quality gates.
Backend Developer (Go) Defines documentation standards: mandatory godoc, review process, quality gates.
Backend Developer (Java/Kotlin) Defines documentation standards: mandatory Javadoc, API doc requirements, review process.
Backend Developer (Node.js) Defines documentation standards: mandatory TSDoc, API doc requirements, review process. Implements documentation quality gates.
Backend Developer (Python) Defines documentation standards: mandatory docstrings, review process, quality gates.
Backend Developer (Rust) Defines documentation standards: mandatory doc comments, review process, freshness metrics. Implements documentation quality gates.
Cloud Engineer Pflicht Defines infrastructure documentation standards: ADR template, runbook structure, service catalog format. Introduces docs-as-code workflow — PR-based updates, automated freshness checks, documentation coverage metrics. Trains teams on documentation culture.
DevOps Engineer Pflicht Defines organizational documentation standards: mandatory documentation for each service, ADR and runbook templates, review processes. Designs Internal Developer Portal with service catalog, automated documentation and search.
Engineering Manager Pflicht Defines documentation-as-code strategy for the engineering organization. Establishes documentation standards, review processes, and quality metrics across teams. Drives developer portal adoption for centralized documentation discovery. Ensures documentation practices support compliance and audit requirements.
Infrastructure Engineer Pflicht Defines infrastructure documentation standards for the organization: mandatory sections for each Terraform module, runbook and playbook templates, ADR standards. Implements docs-as-code pipeline with review process, reviews team documentation for completeness and coordinates on-call handbook creation.
Language Tooling Engineer Pflicht Defines documentation strategy for language tooling platform: unified documentation portal, multi-version documentation hosting, and contributor documentation standards. Establishes documentation review processes and quality gates. Creates guidelines for interactive examples and playground integration in documentation.
QA Engineer (Manual) Pflicht Defines Documentation as Code strategy at the team/product level for QA documentation. Establishes standards for test documentation versioning. Conducts reviews.
QA Security Engineer Pflicht Defines security documentation standards: required documents per project, templates, review process. Implements docs-as-code for security policies and procedures.
Release Engineer Establishes documentation-as-code standards for the release engineering team and makes architectural decisions. Defines the technical roadmap considering this skill. Mentors senior engineers and influences practices of adjacent teams.
Solutions Architect Pflicht Defines documentation strategy for consulting/architecture practice. Establishes standards for architecture deliverables, solution documentation, and client-facing technical content. Creates documentation templates and frameworks for repeatable engagements. Drives adoption of documentation-as-code across client projects.
Technical Lead Pflicht Defines documentation-as-code strategy at the product/department level. Establishes standards for API documentation, architecture decision records, and developer guides. Drives adoption of developer portal (Backstage, Docusaurus) for centralized documentation. Creates governance for documentation ownership and maintenance.
Technical Writer Pflicht Defines organizational docs-as-code standard: workflows, branching strategy for docs, review processes, quality metrics. Coordinates team migration to docs-as-code approach. Creates contribution guidelines for developers.
Rolle Pflicht Beschreibung
Analytics Engineer Pflicht Architects the enterprise data documentation platform: unified portal with dbt docs, BI glossary, and data contracts. Defines the data literacy strategy: onboarding for new analysts, self-service data discovery, automated documentation via AI.
Backend Developer (C#/.NET) Shapes documentation strategy: platform-wide docs-as-code, developer portal, governance.
Backend Developer (Go) Shapes documentation strategy for Go platform organization: docs-as-code standards, developer portal architecture, and documentation governance across teams. Drives documentation as a core engineering practice with measurable quality metrics. Establishes open-source documentation standards for public Go libraries and services.
Backend Developer (Java/Kotlin) Shapes documentation strategy for Java platform organization: Javadoc standards, developer portal with automated API reference aggregation, and documentation governance. Drives documentation as a competitive advantage for internal platform adoption. Establishes documentation quality as an engineering KPI across Java teams.
Backend Developer (Node.js) Shapes documentation strategy: platform-wide docs-as-code, automated generation, developer portal. Defines documentation governance.
Backend Developer (Python) Shapes documentation strategy for Python platform organization: Sphinx/MkDocs infrastructure, automated doc builds from type hints and docstrings, and developer portal governance. Drives documentation as a core engineering practice across Python teams. Establishes open-source documentation standards for public Python packages.
Backend Developer (Rust) Shapes documentation strategy: platform-wide docs-as-code, automated generation, developer experience. Defines documentation governance.
Cloud Engineer Pflicht Shapes enterprise-level documentation strategy: unified service catalog, automated architecture documentation from IaC, knowledge base for operational procedures. Designs internal developer platform with self-service docs, API reference and interactive architecture explorer.
DevOps Engineer Pflicht Develops knowledge management strategy for engineering organization: Internal Developer Portal (Backstage/Port), automated documentation, living docs. Defines knowledge platform architecture: from auto-generation to AI-powered search and recommendations.
Engineering Manager Pflicht Defines enterprise documentation strategy: platform docs-as-code, developer experience standards, and documentation governance across the organization. Drives cultural shift toward treating documentation as a first-class engineering artifact. Evaluates and selects documentation platform investments.
Infrastructure Engineer Pflicht Shapes knowledge management strategy for company infrastructure: Internal Developer Portal architecture with auto-generated documentation, Backstage integration with IaC repositories. Defines technical writing standards for infrastructure, AI-assisted documentation roadmap and documentation coverage metrics for compliance.
Language Tooling Engineer Pflicht Defines organizational documentation strategy for language tooling ecosystem: unified documentation standards, multi-language documentation infrastructure, and open-source documentation practices. Drives documentation as a competitive advantage for developer tool adoption. Shapes industry standards for language documentation.
QA Engineer (Manual) Pflicht Defines enterprise QA documentation strategy: standardized quality reporting, compliance documentation automation, and test evidence management as code. Drives adoption of living documentation practices across QA teams. Shapes organizational culture around documentation-driven quality assurance.
QA Security Engineer Pflicht Designs security knowledge management: organizational security wiki, automated policy distribution, compliance evidence management. Defines documentation governance.
Release Engineer Shapes documentation-as-code strategy for release engineering at the organizational level. Defines best practices and influences technology choices beyond their own team. Is a recognized expert in this area.
Solutions Architect Pflicht Defines enterprise documentation strategy across all architecture practices. Establishes documentation as a core deliverable in architecture governance. Drives standardization of architecture documentation frameworks (TOGAF, C4) across the organization. Influences industry practices through published reference architectures and documentation standards.
Technical Lead Pflicht Defines enterprise documentation-as-code strategy: platform-level documentation infrastructure, developer portal governance, and documentation quality as an engineering KPI. Shapes organizational culture around documentation as a competitive advantage. Drives cross-team documentation standardization and knowledge management.
Technical Writer Pflicht Shapes documentation-as-code strategy at the corporate level. Defines how docs-as-code integrates with SDLC, developer experience, and knowledge management. Ensures scalability of the approach as the organization grows.

Community

👁 Beobachten ✏️ Aenderung vorschlagen Anmelden, um Aenderungen vorzuschlagen
📋 Vorschlaege
Noch keine Vorschlaege fuer Documentation as Code
Kommentare werden geladen...