Markdown
Markdown 标记语法
Markdown 用少量符号排版纯文本。这些符号可创建标题、列表、链接和代码块。
另一个例子
团队只写一份 README。GitHub 会排好版,终端和代码审查也能清楚阅读。
主要部分
- 01被测代码或行为
- 02可观察证据
- 03覆盖、失败与恢复
什么时候用
适合用于指南、Issue 模板、版本说明或有结构的 AI 提示。
什么时候不要用
文本要在多种工具中一致显示时,避免使用平台专属语法。
代码里的名称
CommonMark / GitHub Flavored Markdown 上线前要检查
检查程序运行环境与版本、集成边界、依赖与许可,以及支持的平台。验证安全、失败处理、性能与监控。也要检查部署、支持负责人、升级路径与恢复上一版的方法。
预期结果:把 Markdown 标记语法 (Markdown) 当作团队能维护的技术基础,并检查它是否符合产品需求。 用户场景:团队只写一份 README。GitHub 会排好版,终端和代码审查也能清楚阅读。 技术或工程概念:Markdown 标记语法 (Markdown)。 适用理由:适合用于指南、Issue 模板、版本说明或有结构的 AI 提示。 不应使用的情况:文本要在多种工具中一致显示时,避免使用平台专属语法。 工程适配:定义程序运行环境与版本。说明它负责什么、接口、数据流、依赖、支持平台、安全与性能限制,以及如何接入现有技术组合。 生命周期防护:检查依赖是否健康、许可是否可用。加入监控与安全备用做法,并指定升级负责人。没有可衡量的好处时,不要再加入功能重复的框架或工具。 验收标准:用最小集成证明必要行为。测试兼容性、安全性、失败与性能。记录部署、升级、支持与恢复上一版的方法。 证据与限制(证据边界):正式文档仍可能是草案、候选版或最终版。请查看文档状态,也要确认浏览器或平台是否支持。 待确认:现有技术组合、运行环境、版本规则、目标平台和依赖负责人。也要确认性能预算、支持期限与迁移限制。
检查这份需求
请 AI 编程助手检查当前如何使用 Markdown 标记语法 (Markdown)。 定义:Markdown 用少量符号排版纯文本。这些符号可创建标题、列表、链接和代码块。 生产环境检查:检查程序运行环境与版本、集成边界、依赖与许可,以及支持的平台。验证安全、失败处理、性能与监控。也要检查部署、支持负责人、升级路径与恢复上一版的方法。 修改程序前,先列出看到的证据、缺口、严重程度,以及最小且安全的修正。