软件文档写作

原名:documentation-writer

按照教程、操作指南、参考和解释四类结构编写软件文档。

中文 Skills 技能说明

适合用户文档和技术文档整理。先确认读者和任务,再选择合适文档类型;内容必须与当前软件行为一致,示例避免真实密钥和个人数据,更新文件前保留现有风格和内链。

上游能力依据

上游原始适用说明:Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.

上游 SKILL.md 主要章节(保留原文标题):

使用边界

先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助,不补造客户反馈、经营数据、案例或引用。

作者、翻译与许可证

原作者
GitHub, Inc. 与 awesome-copilot contributors
中文翻译
CEOFans翻译
许可证
MIT
上游来源
https://github.com/github/awesome-copilot/tree/3f0bba475ec40b9680e1d0311b9caffeec5ad4c3/skills/documentation-writer

适用范围

平台:linux、macos、windows;标签:内容与写作、软件文档写作

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。

如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。