skills.rest
joleques
jolequesCOMMUNITY
Explore all skills by this author →
GitHub

workflow-doc-api

Orchestrate api-documentador and api-documentador-revisor to generate multi-layer Codex API documentation.

Updated Apr 5, 2026
Search Tags:#workflow#documentation#api#codex#orchestrator#maker-checker
One-click install
npx skills add https://github.com/joleques/northstar-ai --skill workflow-doc-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: workflow-doc-api
Source: https://github.com/joleques/northstar-ai/tree/main/.codex/skills/workflow-doc-api
Command: npx skills add https://github.com/joleques/northstar-ai --skill workflow-doc-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Orquestra a geração de documentação de API em camadas usando os componentes api-documentador e api-documentador-revisor, seguindo o ciclo Maker/Checker com no máximo 5 iterações para entregar documentação consistente no padrão Codex.

Core Features & Use Cases

  • Orquestration: coordena as skills api-documentador e api-documentador-revisor para produzir documentação de API em etapas sequenciais.
  • Ciclo Maker/Checker: permite até 5 iterações para revisar e ajustar a documentação antes da aprovação final.
  • Persistência de artefatos: salva rascunhos e revisões em ./doc-apis/{titulo}/ e gera o índice final em ./doc-apis/{titulo}/index.md.

Quick Start

Forneça um título e o contexto de negócio opcional para iniciar a geração da documentação da API.

Frequently Asked Questions about workflow-doc-api

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

FAQPage Schema
How do I automate API documentation generation with a maker-checker validation loop?▼

Automating API documentation with a maker-checker validation loop requires orchestrating a documentador and revisor skill sequentially for up to five iterations to refine and validate the output before final delivery.

What is the Codex pattern for generating multi-layer API documentation?▼

The Codex pattern for multi-layer API documentation involves an orchestrated workflow that iteratively generates, reviews, and refines content using a structured maker-checker cycle to ensure consistency.

How do I start an API documentation workflow using a title and business context?▼

To start an API documentation workflow, you provide a project title and optional business context, which initializes parameter collection and triggers the orchestration of drafting and revision skills.

Where are API documentation drafts and final indices saved during an orchestrated workflow?▼

During an orchestrated API documentation workflow, intermediate drafts and revisions are saved in ./doc-apis/{title}/ directories, culminating in a final index generated at ./doc-apis/{title}/index.md.

What happens if API documentation does not pass review within the five iteration limit?▼

If API documentation does not pass review within the five iteration limit, the workflow concludes its maker-checker refinement cycle and delivers the final status based on the last completed iteration.

Can I use this workflow for API projects outside the Codex standard?▼

This workflow is specifically designed for Codex-style API projects, applying a maker-checker loop to validate and refine documentation according to that standard's specific multi-layer requirements.

Related Skills

Explore More Software Engineering Skills→
highflame-aihighflame-ai
4

optimize

Identify API cost inefficiencies and performance bottlenecks across infrastructure dimensions.

Official
Advanced
AndyAnh174AndyAnh174

api-documenter

Generate API documentation from OpenAPI 3.1+ specifications with interactive portals.

Community
Advanced
jolequesjoleques

api-documentador-revisor

Validate API documentation completeness and consistency, then produce a Markdown revision report.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate