skills.rest
alecanche04-cyber
alecanche04-cyberCOMMUNITY
Explore all skills by this author →
GitHub

documentation-engineer

Creates and maintains technical documentation systems, API references, and developer knowledge bases.

Updated Apr 14, 2026
Search Tags:#automation#documentation#openapi#technical writing#knowledge base#developer onboarding#api docs
One-click install
npx skills add https://github.com/alecanche04-cyber/examenprograma --skill documentation-engineer-alecanche04-cyber
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-engineer
Source: https://github.com/alecanche04-cyber/examenprograma/tree/main/EXAMEN_PROGRA_2-master/.agents/skills/documentation-engineer
Command: npx skills add https://github.com/alecanche04-cyber/examenprograma --skill documentation-engineer-alecanche04-cyber

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Development teams struggle with scattered, outdated, or missing documentation that slows onboarding, increases support questions, and loses institutional knowledge when engineers leave. ## Core Features & Use Cases - Documentation Architecture: Design scalable documentation platforms with information architecture, search, versioning, and multi-format support using tools like Docusaurus, VitePress, and MkDocs. - API Documentation: Generate interactive API references with OpenAPI/Swagger, code samples in multiple languages, and try-it functionality. - Documentation Automation: Set up CI/CD-integrated doc generation, link validation, and freshness tracking to keep content synchronized with code. - Use Case: A team with 50+ microservices uses this Skill to build an OpenAPI-based documentation portal with auto-generated references, interactive explorers, and version-tied releases, cutting new-hire ramp time in half. ## Quick Start Ask the assistant to design a documentation platform for your API with auto-generated references, developer guides, and CI/CD-integrated publishing.

Frequently Asked Questions about documentation-engineer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up automated API documentation from code?▼

Generate OpenAPI specifications from code annotations, then render them with Swagger UI or Redoc for interactive exploration. Integrate the generation step into CI/CD so documentation rebuilds automatically on every code change.

What static site generator should I use for developer documentation?▼

Docusaurus suits React teams needing MDX and plugins, VitePress offers fast Vue-based builds, and MkDocs provides simple Python-based markdown documentation. Choose based on your team's existing tech stack and theming needs.

How do I keep documentation synchronized with code changes?▼

Automate documentation builds in CI/CD pipelines, add link validation and code sample testing, and track content freshness metrics. Assign documentation owners per area and run regular audits to catch stale content.

What are Architecture Decision Records and when should I use them?▼

ADRs are structured documents capturing context, decision, consequences, and status for significant technical choices. Use them for architectural changes requiring review to preserve rationale and ease future onboarding.

How do I measure whether my documentation is effective?▼

Track page views, search analytics, time on page, and search success rates to find gaps. Combine usage analytics with user interviews and feedback systems to guide continuous improvement.

Related Skills

Explore More Software Engineering Skills→
rsts-devrsts-dev
17

Docs

Generate architecture, API reference, setup, and deployment docs from codebase analysis.

Official
Intermediate
maltemdmaltemd

designing-developer-onboarding

Design developer onboarding documentation and sequences for APIs and platforms.

Community
Intermediate
daanteijema-beepdaanteijema-beep

doc-coauthoring

Guide structured documentation co-authoring with context gathering and reader testing.

Community
Advanced
victor-brechbillvictor-brechbill
1

mintlify

Build Mintlify documentation sites from MDX files and OpenAPI specs.

Official
Intermediate