SuperAPI AI 工具集

document-writer

写作与研究

查看项目

更新于 10-16 06:51

技能介绍

用途:document-writer 是一项专业文档编写技能,适用于需要编写或改进文档的场景,覆盖技术文档、README、API 文档、用户手册等。

主要能力:支持四类文档。README 涵盖项目简介、安装说明、快速开始、配置选项、API 参考与贡献指南;API 文档涵盖接口描述、请求/响应格式、参数说明、错误码与使用示例;用户手册涵盖功能介绍、操作步骤、常见问题与故障排除;技术规范涵盖架构设计、数据模型、流程图与接口规范。

写作原则:清晰性,使用简洁明了的语言,避免歧义和模糊表达,提供具体示例;完整性,覆盖所有必要信息,包含先决条件,说明边界情况;可用性,逻辑结构清晰,易于导航,提供搜索友好的标题。

使用方式:先确定文档类型和目标读者,再收集必要信息,按模板结构组织内容,审查和优化表达,最后添加示例和图表。资料中提供了 README 模板结构,包含项目名称、简短描述、特性、安装、快速开始、配置表格与许可证等章节。

限制:资料未提供具体安装命令、调用方式、平台支持、收费或价格信息,暂未提供。