tasks-documentation

The tasks-documentation skill provides a structured framework for developers and technical writers to maintain high-quality project documentation. It is designed to bridge the gap between implementation and communication by offering standardized patterns for code-level documentation and project-level overviews. By focusing on consistency, it ensures that your repository remains readable, maintainable, and accessible to other team members. The skill is particularly well-suited for engineering teams working in C# and TypeScript environments, though its patterns are adaptable to various modern software stacks.

• Generates comprehensive C# XML documentation, including complex tags like summary, remarks, and example sections to improve IntelliSense and API clarity.

• Creates professional TypeScript JSDoc comments that support advanced documentation requirements, including example usage, parameter descriptions, and type documentation.

• Produces standardized API documentation for REST controllers, detailing request/response schemas, error code definitions, and endpoint descriptions.

• Offers structured README templates that include architecture diagrams, installation guides, and usage examples to streamline project onboarding.

• Facilitates the documentation of technical debt through consistent TODO and FIXME comment patterns, allowing teams to track and address issues effectively.

• Supports architectural documentation by providing frameworks for data flow descriptions and component diagram outlines.

• This skill is intended specifically for writing and generating documentation. It should not be used for high-level documentation planning or strategic roadmapping; for such tasks, please utilize the designated documentation planning skills.

• Input typically involves source code snippets, function definitions, or architecture concepts; output is formatted, ready-to-use documentation text that adheres to industry best practices.

• Ensure that all documentation produced follows the project's established style guide; while this skill provides robust templates, human oversight is recommended to verify accuracy in complex logic scenarios.

• Use this skill to keep README files synchronized with code changes, ensuring that technical debt is tracked and that public-facing API interfaces are always properly annotated with professional-grade documentation.