Results for “documentation-standards”

Creates high-quality software documentation following the Diátaxis framework, covering tutorials, how-to guides, reference, and explanation documents.

Generates, formats, and validates technical documentation including docstrings, OpenAPI specs, JSDoc annotations, documentation sites, and user guides.

Creates, structures, and reviews technical documentation using the Diátaxis framework, organizing content into tutorials, how-to guides, reference material, and explanations.

Generate structured documentation templates for components, patterns, or guidelines within a design system.

Enforces system design, project structure, dependency management, error handling, testing, and documentation standards at principal-engineer level.

Build and review high-quality technical documentation, including agent instruction files and contributor-governance files, with support for audits, multilingual parity, and sub-agent orchestration.

Documents, standardizes, and governs a Vue 3 + shadcn-vue design system, including component documentation templates, patterns for forms, empty states, loading states, and feedback, plus a consistency checklist and conventional commit conventions.

Update docs/index.md and write Google-style docstrings for NeMo-RL documentation changes.

Review documentation and prose for compliance with writing guidelines, checking style, voice, and tone against a fetched rule set.

Audits top-level documentation against recent git history to detect drift, applies minimal edits, and opens a pull request.

Guides users through a structured three-stage workflow for co-authoring documents, from context gathering to reader testing.

Audits type safety documentation against the live codebase and fixes errors, gaps, or stale information to keep docs authoritative.

Create, edit, and verify agent skills using test-driven development to ensure agents follow documented procedures correctly.

Creates scientific documentation using markdown with embedded Mermaid diagrams as the default format, enforcing a text-based diagram standard with style guides, 24 diagram type references, and document templates.

Create developer handoff specifications with measurements, behaviors, assets, and edge cases.

Synchronizes documentation, READMEs, release notes, and operating docs with current shipped behavior when they have drifted.

Generates customizable prompts for scanning codebases to identify and document high-quality code exemplars, supporting multiple programming languages and configurable analysis depth.