Documenta um alvo específico do seu código — uma API, um componente, um módulo ou uma função — com o detalhe técnico que quem vai usar aquilo precisa.
Uso
/ww:doc:tech-document src/auth/login.ts --type component --style detailed
/ww:doc:tech-document src/api/users.ts --type api --style brief
Argumentos
| Argumento | Obrigatório? | Descrição |
|---|
<target> | Sim | O que documentar: um arquivo, uma função, um componente ou um módulo. |
--type api|component|module|function | Opcional | O tipo do alvo — api, component, module ou function. É isso que decide o formato do documento. |
--style brief|detailed | Opcional | brief traz o essencial (parâmetros e retornos); detailed traz arquitetura, exemplos e tratamento de erro. |
Notas
O documento é salvo na pasta de documentação do projeto, com a data no cabeçalho, a menos que você indique outro caminho.
Ao publicar uma API para outro time consumir, ao entregar um componente para o design system, ou quando um trecho crítico do sistema precisa parar de viver só na cabeça de quem escreveu.
- O alvo — o arquivo, a função, o componente ou o módulo a documentar.
--type — o tipo do alvo: api, component, module ou function. É isso que decide o formato da documentação.--style — brief para o essencial (parâmetros e retornos) ou detailed para o completo (arquitetura, exemplos e tratamento de erro).
| Tipo | O que a documentação cobre |
|---|
api | Especificação do endpoint, parâmetros e esquemas da requisição, formatos de resposta e códigos de status, tratamento de erro, autenticação e autorização, limites de uso, exemplos e notas de integração |
component | Propósito e uso, propriedades de entrada com seus tipos, eventos e callbacks, estado, ciclo de vida, estilo e customização, acessibilidade e exemplos |
module | Propósito e escopo, o que ele expõe, dependências, opções de configuração, exemplos e considerações de performance |
function | Assinatura e parâmetros com tipos, retorno, exceções e erros, exemplos, características de performance, casos de borda e limitações |
- O documento é salvo na pasta de documentação do projeto, com a data no cabeçalho, a menos que você indique outro caminho.
- O escopo é um alvo por vez. Para o projeto inteiro, use o /ww:doc:project-index.
