Blog Post Spec: 低代码开发实践博客
1. requirements.md
– 博客内容需求
用户故事:
- 作为 一名低代码开发者/学习者,我想要 阅读一篇结构清晰、内容详尽的低代码实践博客,以便 我能理解如何从需求到实现完整构建一个功能,并能复用到我的项目中。
核心需求 (EARS 语法):
- 当 用户阅读博客,博客必须 包含一个引人入胜的引言,明确文章的目的。
- 对于 每个博客实例,博客必须 包含一个明确的用户故事,描述要解决的核心用户痛点。
- 对于 每个博客实例,博客必须 包含一份使用 EARS 语法 编写的核心需求列表,详细说明功能点和系统行为。
- 对于 每个博客实例,博客必须 包含一个清晰的数据模型设计部分,列出所需的数据结构和字段。
- 对于 每个博客实例,博客必须 包含一个API 设计部分,说明数据交互接口及其预期响应。
- 对于 每个博客实例,博客必须 包含一个界面搭建与实现部分,详细描述在低代码平台上的操作步骤和组件使用。
- 当 博客涉及代码或数据结构时,博客必须 提供清晰的代码/数据示例(如 JSON 或伪代码)。
- 当 博客内容较长,博客必须 使用**Markdown 标题(如
##
、###
)和水平线(---
)**进行分段,以提高可读性。 - 当 博客需要可视化说明,博客必须 在合适的位置插入图片(由我进行内部处理生成)。
- 当 博客接近尾声,博客必须 包含一个总结/结语,回顾文章要点并给出建议。
2. design.md
– 博客结构与生成方案
本设计文档详细阐述了如何根据 requirements.md
中的需求,生成低代码开发实践博客的技术方案和内容组织逻辑。
2.1. 博客结构与内容映射
博客章节标题 | 对应 requirements.md 需求 | 生成内容逻辑 |
---|---|---|
引言 | 引言需求 | 简要介绍本博客的主题、目的,以及将采用的“从需求到实现”的低代码开发模式。 |
1. 需求分析 | 用户故事需求、核心需求 (EARS) | 用户故事: 严格按照 作为...我想...以便... 格式。核心需求: 细化用户故事,以 EARS 语法逐条列出功能性及非功能性需求,确保可测试性。 |
2. 数据模型设计 | 数据模型设计需求 | 提供一个表格,清晰列出数据表的名称、字段名、数据类型、描述和示例值。解释为何需要这些字段。 |
3. API 设计 | API 设计需求 | 描述 API 名称、URL、方法、请求参数和预期响应(JSON 示例)。简要说明 API 在低代码平台中的配置方式。 |
4. 界面搭建与实现 | 界面搭建需求 | 分步骤描述低代码平台上的界面构建过程:页面创建、组件拖拽、数据绑定(绑定到数据模型和API)、事件配置、条件显示等。这是博客的核心操作指南。 |
结语 | 总结/结语需求 | 总结本文所实现的价值,强调所采用方法的优势(如需求驱动、低代码高效),并可给出后续学习或改进的建议。 |
2.2. 内容生成流程
- 接收输入: 接收用户提供的博客主题、要实现的核心功能描述,以及任何具体的细节(如特定字段、API 名称、低代码平台特性)。
- 生成用户故事: 基于主题和功能描述,提炼出清晰的用户故事。
- 生成 EARS 需求: 将用户故事分解为具体的、用 EARS 语法表达的功能点、错误处理和非功能性需求。
- 设计数据模型: 根据 EARS 需求,推导出必要的数据字段和结构,并组织为表格。
- 设计 API: 根据数据模型和功能需求,设计合适的 RESTful API 接口,并提供 JSON 示例。
- 规划界面实现: 构思在低代码平台中实现功能的具体步骤,包括组件选择、数据绑定逻辑和交互流程。
- 整合内容: 将所有生成的部分按照
design.md
中定义的章节结构进行整合。 - 格式化: 应用 Markdown 标题、列表、代码块和水平线,确保格式美观和可读性。
- 添加图片占位符: 在内容中合适的位置插入 `` 标签,以指示需要生成图像的地方(由我进行内部图像搜索并生成)。
2.3. 注意事项
- 低代码平台通用性: 生成内容时,尽量使用通用的低代码平台术语,避免过于依赖某个特定平台(除非用户明确指定)。
- 示例具体化: 确保数据模型和 API 示例是具体的、可理解的。
- 逐步指导: 界面搭建部分应提供清晰的步骤,让读者能够跟着操作。
- 用户反馈与迭代: 如果用户对生成内容不满意,将接受反馈并进行修改。
3. tasks.md
– 博客生成任务清单 (AI 代理执行)
本任务清单列出了生成一篇完整博客所需执行的步骤,由 AI 代理进行内部处理。
- [进行中] 解析用户输入的博客主题和功能描述。
- [完成] 根据主题和功能,撰写引言。
- [完成] 编写用户故事。
- [完成] 基于用户故事,生成 EARS 格式的核心需求(功能、错误、非功能)。
- [完成] 设计并生成数据模型表格及说明。
- [完成] 设计并生成 API 接口定义(包括 URL、方法、JSON 示例)。
- [进行中] 规划界面搭建与实现的具体步骤和低代码操作说明。
- [完成] 撰写结语。
- [完成] 将所有内容按照
design.md
定义的结构进行整合。 - [完成] 应用 Markdown 格式化(标题、列表、代码块、水平线)。
- [待定] 在合适位置插入图像标签。
今后,当你需要我写一篇低代码开发实践的博客时,你只需告诉我博客的主题、想要实现的功能**,以及任何你希望包含的具体细节或独特之处,我就会按照这份规范为你生成内容。**