返回顶部
f

frontend-tech-doc-guide前端技术文档指南

规范 AI 生成飞书技术文档结构,确保 Markdown 层级正确、章节顺序稳定、可读性高。

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
96
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

frontend-tech-doc-guide

一、文档结构规则(必须严格遵守)

1. 标题层级规则

文档标题层级 必须严格按以下结构生成,不允许跳级

文档标题

一、需求认知

需求 PRD:xx 飞书项目:xx 后端文档:xx UI 设计稿:xx
  • - 需求背景
  • 需求目标
  • 核心/特殊改动点

二、项目排期

三、功能流程

1. 页面流程

2. 功能流程

...其他流程

四、需求拆分

五、业务埋点 & Sentry 监控

六、数据链路

七、提测信息

八、验收与上线

九、待确认问题

二、章节生成顺序(防止内容错位)

AI 必须严格按以下顺序生成内容

  1. 1. 需求认知
  2. 项目排期
  3. 功能流程
  4. 需求拆分
  5. 业务埋点 & Sentry 监控
  6. 数据链路
  7. 提测信息
  8. 验收上线
  9. 待确认问题

关键约束

生成时必须遵守:

  • * 不得提前生成后续章节内容
  • 不得回写前文
  • 不得复制后文内容到前文

例如禁止出现:

开头出现:
第7章内容
第8章内容

若模型生成时出现重复章节,必须:

  • * 删除重复段
  • 保留第一次出现的位置

三、段落排版规则(提升可读性)

AI 生成内容时 禁止连续长文本块

每段说明 必须拆分为以下结构之一

1 优先使用列表

错误示例:

系统需要完成登录、鉴权、资格校验、任务获取、抽奖逻辑等功能。

正确示例:

系统主要流程包括:

  • - 登录
  • 身份鉴权
  • 资格校验
  • 任务获取
  • 抽奖执行

2 技术描述必须结构化

统一使用 模块结构

模块名称

  • - 功能说明
  • 接口
  • 关键逻辑
  • 依赖

示例:

积分活动模块

功能:

  • - 展示用户积分
  • 提供抽奖入口

接口:

  • - getUserPoints
  • drawLottery

关键逻辑:

  • - 未登录先触发登录
  • 积分不足提示

四、流程章节规范(必须包含 Mermaid)

流程章节 必须包含 Mermaid 图

示例:

mermaid
flowchart TD
Entry[活动入口] --> Login{是否登录}
Login -- 否 --> Auth[手机号授权]
Login -- 是 --> Check[资格校验]
Check --> Task[任务列表]
Task --> Draw[抽奖]
Draw --> Result[结果弹窗]

生成规则:

  • * Mermaid 只允许出现一次代码块
  • 使用
    换行
  • 不允许使用 \n

五、模块拆分规则

模块章节必须按以下格式生成:

模块名称

功能:

  • - xxx
  • xxx

核心逻辑:

  • - xxx
  • xxx

接口:

接口说明
getTask获取任务
drawLottery
抽奖 |

依赖:

  • - 风控接口
  • 奖品接口

禁止生成 长段技术说明文字



六、埋点章节格式

必须使用表格。

示例:

事件code触发时机参数
页面曝光pageview页面加载...
抽奖点击
drawclick | 点击抽奖 |...|
| 抽奖成功 | draw_success | 返回中奖 |中奖结果|


七、提测信息格式

表格结构

八、AI 生成质量规则(重点)

AI 在生成文档前必须执行:

1 章节检查

确认存在以下章节:

  • * 需求认知
  • 项目排期
  • 功能流程
  • 需求拆分
  • 业务埋点 & Sentry 监控
  • 数据链路
  • 提测信息
  • 验收上线
  • 待确认问题

缺一不可。



2 排版检查

确保:

  • * 无连续超过 5 行纯文本段落
  • 必须包含

* 列表
* 表格
* Mermaid



九、AI 输出限制

AI 输出文档时必须遵守:

1 不输出解释

只输出 Markdown 文档

2 不输出多版本

只输出最终版本

3 不输出空章节

无内容时写:

待补充



十、推荐文档标题格式

【YYMMDD】活动简称-前端技术方案

示例:

【260320】春季直播活动-前端技术方案



十一、生成目标

AI 生成的文档必须达到:

  • * Markdown 层级正确
  • 飞书渲染结构稳定
  • 章节顺序正确
  • 信息结构化
  • 可读性高

否则视为生成失败。

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 frontend-tech-doc-guide-1775972703 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 frontend-tech-doc-guide-1775972703 技能

通过命令行安装

skillhub install frontend-tech-doc-guide-1775972703

下载

⬇ 下载 frontend-tech-doc-guide v1.0.0(免费)

文件大小: 3.24 KB | 发布时间: 2026-4-13 10:23

v1.0.0 最新 2026-4-13 10:23
- Initial release of the frontend-tech-doc-guide skill.
- Defines strict rules for AI-generated Feishu technical documents, focusing on correct Markdown heading hierarchy and stable section order.
- Specifies structured templates for each document section, including use of lists, tables, and mandatory Mermaid diagrams.
- Enforces clear readability standards to avoid long continuous text blocks.
- Outlines detailed requirements for module breakdown, data tracking, and acceptance sections.
- Sets quality checks and output constraints to ensure high-quality, consistent documents.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部