专业版前端工程产品说明文档提示词

角色定义与任务定位

请以“资深前端技术写作者”或“产品技术文档架构师”的身份，运用本方案。你的核心目标是：为一项前端工程产品或技术方案（如UI组件库、构建工具、开发框架等），生成一份逻辑严谨、描述准确、便于开发者理解与使用的专业说明文档。

适用场景

• 为开源或商业前端库/框架撰写官方API文档与使用指南。
• 为内部团队的前端基建（如微前端方案、CLI工具）编写技术规格说明书。
• 为复杂的前端组件（如数据可视化图表、富文本编辑器）制作详细的产品功能说明。
• 准备面向开发者的产品技术白皮书或集成手册。

核心提示词

可直接复制并填充具体产品名的提示词结构：

• “撰写一份关于 [产品名称，如：Vue3 Admin Template] 的专业产品说明文档，目标读者是中级前端开发者。文档需包含：1. 产品概述与核心价值；2. 快速开始指南（安装、引入、第一个示例）；3. 核心特性详解与代码示例；4. API 接口详细说明；5. 常见问题与排错指南；6. 版本更新日志。”
• “为 [技术方案名称，如：状态管理插件] 创建说明文档，重点突出其与同类方案的差异优势，使用对比表格说明性能、语法和生态，并提供从旧版本或竞品迁移的详细步骤。”
• “生成 [UI组件名称，如：可拖拽排序表格组件] 的说明文档，要求以‘属性’、‘事件’、‘方法’、‘插槽’分类阐述，每个条目附上类型定义、默认值、说明及一个简洁的Vue/React使用示例代码片段。”

风格方向

• 语言风格：客观、精准、简洁。避免营销化口语，使用技术术语但不过度晦涩。采用主动语态，如“本组件接收以下参数”。
• 文档结构：层级分明，遵循“总-分-详”逻辑。使用清晰的标题层级（H1, H2, H3），并建议在开头提供目录锚点。
• 视觉辅助：在文本中预留代码块、流程图（Mermaid语法）、参数表格的位置指示，增强可读性。

构图建议（信息架构）

• 封面页构图：文档标题 + 产品Logo + 版本号 + 最后更新日期。
• 主体信息流：按“为什么（概述）- 怎么做（快速上手）- 是什么（深度解析）- 怎么办（参考与排错）”的顺序组织章节。
• 重点突出：将“快速开始”章节置于显眼位置，确保开发者在30秒内能运行第一个Demo。将高级配置和原理剖析后置。

细节强化

• 代码示例：确保示例完整、可运行，并注释关键行。同时提供CodeSandbox或GitHub仓库的链接提示。
• 版本兼容性：明确标注支持的环境、浏览器版本、Node版本、框架版本（如Vue 2/3, React 16.8+）。
• 术语一致：全文对同一概念使用统一称谓，并在首次出现时提供简短解释或链接到详细章节。
• 交互提示：在可能引起警告或错误的配置项旁，添加“注意”、“警告”等醒目提示框。

使用建议

• 在使用核心提示词时，将方括号 `[]` 中的占位符替换为您的具体产品信息。
• 可根据文档阶段（初稿、迭代、发布）选择不同侧重点：初稿重结构完整，迭代重细节与示例，发布前重校验与兼容性说明。
• 建议搭配版本管理工具（如Git）进行文档的版本控制，更新日志章节应与代码发布版本严格同步。
• 最终产出可部署至静态文档站点生成器（如VuePress, Docusaurus）以获得最佳阅读体验和搜索功能。