skills.rest
rub803030
rub803030COMMUNITY
Explore all skills by this author →
GitHub

documentation-engineer

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Development teams struggle with scattered, outdated, or missing documentation, which slows onboarding, increases support questions, and loses architectural 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. - Automation & CI/CD Integration: Automate documentation generation from code, validate links, test code samples, and keep content synchronized with releases. - 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 docs, cutting new-hire ramp time in half. ## Quick Start Ask the AI to design a documentation platform for your API with auto-generated OpenAPI 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, extract docs from code metadata, and run link validation plus code sample testing on every commit. Assign documentation owners and schedule regular freshness audits.

Does OpenAPI documentation support interactive API testing?▼

Yes, Swagger UI and Redoc render OpenAPI specs with try-it functionality, letting developers execute live requests against real endpoints directly from the documentation with pre-configured authentication.

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.

Related Skills

Explore More Software Engineering Skills→
isiouisiou

code-documentation-doc-generate

Generate API references, architecture diagrams, READMEs, and user guides from source code.

Community
Advanced
jc180105jc180105

Developer Advocate

Audit developer onboarding and create a 90-day engagement plan.

Community
Advanced
Jimmy1987sJimmy1987s

receiving-code-review

Validate code review feedback against the codebase before implementation.

Community
Intermediate
vercel-labsvercel-labs
5.8k

ai-sdk

Answer AI SDK questions and implement agents, streaming, and structured output with current APIs.

Official
Intermediate