tasks-documentation

tasks-documentation 技能为开发人员和技术撰稿人提供了一个结构化的框架，用于维护高质量的项目文档。它旨在通过为代码级文档和项目级概述提供标准化模式，来弥合实现与沟通之间的差距。通过专注于一致性，它确保您的存储库保持可读性、可维护性并可供其他团队成员存取。该技能特别适用于在 C# 和 TypeScript 环境中工作的工程团队，尽管其模式也适用于各种现代软件栈。

• 生成全面的 C# XML 文档，包括诸如 summary、remarks 和 example 部分等复杂标签，以改善 IntelliSense 和 API 清晰度。

• 创建专业的 TypeScript JSDoc 注释，支持高级文档需求，包括示例用法、参数描述和类型文档。

• 为 REST 控制器生成标准化的 API 文档，详细说明请求/响应架构、错误代码定义和端点描述。

• 提供结构化的 README 模板，包括架构图、安装指南和使用示例，以简化项目导入流程。

• 通过一致的 TODO 和 FIXME 注释模式促进技术债的文档化，允许团队有效跟踪和解决问题。

• 通过提供数据流描述和组件图大纲的框架来支持架构文档化。

• 此技能专门用于编写和生成文档。它不应用于高层次的文档规划或策略蓝图设计；对于此类任务，请使用指定的文档规划技能。

• 输入通常涉及原始代码片段、函数定义或架构概念；输出是格式化、随时可用的文档文本，遵守行业最佳实践。

• 确保生成的所有文档都遵循项目既定的样式指南；虽然此技能提供了强大的模板，但建议进行人工审查以验证复杂逻辑场景下的准确性。

• 使用此技能保持 README 文件与代码更改同步，确保技术债得到跟踪，并确保对外 API 接口始终正确注释专业级的文档。