documentation-writer_skill

Overview

This skill generates comprehensive project and code documentation including README files, API references, code comments (JSDoc, docstrings, XML), and architecture notes. It produces clear, actionable documentation tailored to TypeScript and other common languages. The output is ready to drop into repositories or use as a starting point for maintainers and contributors.

How this skill works

Provide the codebase, function signatures, or a brief project description and the skill produces structured docs: a README with quick start and usage, API reference tables, and inline comment blocks such as JSDoc or XML comments. It can generate examples, environment variable guidance, installation steps, contribution guidelines, and common error/exception documentation. Outputs are formatted for developer consumption and can be customized for tone, level of detail, or target audience.

When to use it

• You need a complete README for a new or existing project.
• You want consistent JSDoc, docstrings, or XML comments across code modules.
• Preparing API reference documentation for public or internal APIs.
• Onboarding contributors with quick start, environment, and contribution steps.
• Documenting architecture, data models, and error-handling behavior.

Best practices

• Provide function signatures, types, and a few example inputs/outputs for accurate comments.
• Keep environment and installation details current and concise.
• Use concrete examples in usage and API sections to reduce ambiguity.
• Document expected errors and validation rules alongside return types.
• Review and adapt generated text for project-specific policies and naming conventions.

Example use cases

• Generate a polished README with features, quick start, environment vars, and license.
• Create JSDoc blocks for service classes and public library methods in TypeScript.
• Produce API reference tables that list parameters, types, required flags, and return values.
• Add XML documentation for C# public APIs including exceptions and examples.
• Draft architecture notes describing components, data flow, and deployment considerations.