📝ContenuIntermediate3 steps

Technical Documentation Writer

This agent generates comprehensive and readable technical documentation from your code, specifications or technical notes: API docs, user guides, READMEs and architecture guides.

documentationdéveloppementAPItechnique

For who

Developers, tech leads, product teams, DevRel

steps (3)

Code analysis and information extraction

prompt

Analyze the source code and identify elements to document.

API documentation and guides writing

prompt

Generate structured documentation with examples.

Getting started guide and README

prompt

Create the quick start guide and project README.

Input

Type: Code source ou spécifications

Format: Code, pseudo-code ou notes techniques

Code source, fonctions, classes, API endpoints ou spécifications fonctionnelles à documenter

Glossary Terms

Chain-of-thought Few-shot prompting Prompt injection Context Top-p (nucleus sampling)GPT Prompt leaking Hallucination