网站

产品文档站搭建提示词

创建支持搜索、快速入门、故障排查和版本提示的产品文档网站。

编辑审核 · Vibe Coding ·

适用场景

适合已有可核查的安装说明、参考资料和版本记录的产品或开源项目。

可复制的完整构建指令

为 [READERS] 构建 [PRODUCT] 的公开文档,首要目标是 [FIRST TASK]。以项目提供的资料为准,标出样例值和未核实的命令。

功能与实现要求:
1. 规划快速入门、任务指南、参考、排错和更新日志。指南说明前置条件、预期结果和下一步。
2. 为文章设置稳定地址、清楚标题、目录和面包屑,从索引链接到所有公开章节。支持移动端和键盘导航。
3. 搜索标题、正文与错误短语,展示结果章节并处理无结果。草稿不得出现在搜索、sitemap 或匿名可访问页面。
4. 在相关指令旁说明当前或适用版本,迁移旧地址时添加重定向。复制的代码去掉命令提示符并使用凭据占位符。
5. 提供编辑或反馈入口及事实依据,在全新环境验证快速入门。交付一篇入门、一篇排错和一条更新日志。
只展示已验证的平台专用命令。检查构建后的标题层级、代码块和深链接,并用键盘从搜索结果进入目标章节。

使用前替换的项目资料: [PRODUCT], [READERS], [FIRST TASK].

优先适配移动端,使用语义化结构、清晰标签和可见的键盘焦点。使用真实内容,或明确标注演示数据。为关键流程提供加载、空数据、错误和成功状态。只有界面而没有真实后端时,不得声称集成已经完成。交付前列出尚需接入的服务,并亲自验证核心流程。

验收标准:
- 快速入门在干净环境可执行。
- 已知错误可搜到,草稿不会出现在结果中。
- 已迁移的文章地址会跳到注明版本的新页。
查看完整英文参考模板
Build public documentation for [PRODUCT] serving [READERS]. The most important first success is [FIRST TASK]. Use only source material supplied by the project. Mark sample values and flag unverified commands instead of inventing features.

1. Separate a quick start, task guides, reference, troubleshooting, and changelog. Each guide states prerequisites, expected results, and the next step. Show platform-specific commands only when verified.
2. Give each article a stable slug, visible page title, local table of contents, and breadcrumbs. Maintain a docs index with links to every public section. On narrow screens, make the navigation and search usable by touch and keyboard.
3. Search titles, body text, and error phrases. Show where each result comes from and handle no results. Exclude unpublished pages from search, sitemap, and anonymous access.
4. Put the current version and supported versions near affected instructions. Maintain redirects for moved pages and warn on archived versions. Copyable code must exclude shell prompts and use placeholders instead of credentials.
5. Include an edit or feedback link and a source for factual claims. Check the quick start from an empty project and verify all links, headings, and code blocks in the built output.

Deliver a sample quick start, a troubleshooting article, and a changelog entry. Verify direct URLs, keyboard search, and an old link that redirects to its replacement.

使用步骤

  1. 选择最接近的目标

    按页面类型和用户流程选择模板。

  2. 替换变量

    填入真实受众、产品目标、内容、视觉方向和技术限制。

  3. 发送前编辑

    删去首版不需要的功能,解决要求之间的冲突。

  4. 测试并迭代

    逐项验证移动端、无障碍、交互、数据一致性和异常状态。

AI 编程工具比较

预期成果

可抓取且可搜索的公开文档站,使读者找到正确的入门步骤和适用版本。

为什么这样设计

  • 按读者要完成的任务组织资料
  • 把稳定链接和出处纳入设计
  • 要求实际执行入门步骤并检查旧链接

验收标准

  • 快速入门在干净环境可执行。
  • 已知错误可搜到,草稿不会出现在结果中。
  • 已迁移的文章地址会跳到注明版本的新页。

使用前替换的项目资料

[PRODUCT]
接入新命令行工具的开发者
[READERS]
开源图片缩放工具
[FIRST TASK]
缩放一张图片并找到输出文件

资料来源与审核依据

下列资料用于核对方法和技术要求;提示词由本站独立编写。

全部 Vibe Coding 提示词

常见问题

创建支持搜索、快速入门、故障排查和版本提示的产品文档网站。

这个提示词会生成什么?

可抓取且可搜索的公开文档站,使读者找到正确的入门步骤和适用版本。

发送前要改哪些内容?

使用前替换的项目资料 · [PRODUCT], [READERS], [FIRST TASK]. 删去不需要的功能,加入项目实际的技术、品牌和内容约束。

适合哪些 AI 编程工具?

Vibe Coding, Lovable, Bolt. 请核对工具对框架、数据库、认证与部署的支持。

初学者能用吗?

难度 · 中级. 首版用时 · 取决于构建工具. 仍需检查生成结果、测试交互,并验证生产环境行为。

能在生成前编辑吗?

可以。复制完整提示词,先在所选工具里修改,再按需要提交。

模板是怎样审核的?

编辑检查目标、约束、界面状态、响应式行为和无障碍,并参考下列资料 · Product Knowledge Hub, Google Search Essentials.

复制模板并开始构建

先替换变量,选择合适的工具,再用验收标准检查结果。