技术文档写作助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_ee2354b0/tech-doc-writer。
技能介绍
要解决什么问题
招投标方案、设计说明、接口文档、架构说明往往散落在 docx、pdf、md 里,还要对齐公司模板或招标大纲。人工拼稿容易漏节、术语不一致,写完也很难按评分细则自检。
技能如何工作
技能在开始前会区分两种模式:写作模式(默认)按素材与大纲生成新文档;评审模式只读已有文稿并打分,也可在写完后再串联评审。
写作侧会先澄清参考目录、大纲/模板、输出路径与文档类型,盘点素材并建「素材地图」;读文件时优先用环境里已有的 docx/pdf 等专用 skill,再按需解析模板层级与占位说明。随后按节编写:从原材料提炼正文,插入 Mermaid 图与 Markdown 表,长文会按一级章节分批交付。缺材料时按文档类型处理——应标类可合理补全但用 HTML 注释标出,设计/接口类则 > ⚠️ 待补充 而不编造字段与性能数据。
评审侧按用户提供的评分细则,或内置的招投标/设计/接口/架构标准,逐维度打分并记录 🔴🟡🟢 优先级问题,输出 .review.md;只评不改原文。
适用边界
具体接口参数、表结构、版本号、性能数字必须来自参考文档。语气与粒度需贴近源材料;中英文与数字之间留空格,标题层级对齐模板,勿擅自加深层级。
使用场景
- 手头有多份需求与设计 docx/pdf,需按公司模板合并成一份完整产品设计说明
- 投标截止前,要基于开发设计资料按招标大纲生成招投标技术方案 Markdown
- 已有接口说明与代码注释,需按规范整理成带表格与时序图的接口文档
- 方案初稿写完,需按招标文件评分细则出一份维度得分与问题清单的评审报告
适合人员
- 负责应标的技术经理,要把研发材料快速对齐招标章节并标出缺料与推断段落
- 架构师或技术负责人,需从架构资料按固定大纲输出系统架构说明并插入 Mermaid 拓扑图
- 接口负责人,要把零散接口材料写成客观严谨的 Markdown 接口文档且禁止编造字段参数
- 文档质量把关人,要对他人或本 skill 产出的方案按内置或自定义标准打分但不改原文