Fitten Code写Markdown:利用AI辅助撰写结构清晰的技术设计文档

落涛酱_5786

落涛酱_5786

2026-06-25

465人浏览

原创

使用fitten code写技术设计文档需首句明确输入输出与约束,用---分隔业务目标与限制,按ddd或表格驱动分段生成,伪代码须用`pseudo标记并抽象化,接口定义后须基于yaml生成小驼峰go结构体。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

fitten code写markdown:利用ai辅助撰写结构清晰的技术设计文档

用Fitten Code写技术设计文档时,需要让AI理解模块边界、数据流向和约束条件,否则生成内容容易堆砌术语、遗漏关键接口定义或忽略错误处理路径。

明确输入输出与核心约束

在Fitten Code的对话框里第一句就写清:【必须包含:输入参数类型、输出结构JSON Schema、失败时HTTP状态码与错误字段】。这一步漏掉,后续所有生成都可能偏离工程落地要求。

接着用三行分隔符(---)切出上下文区块,上面写业务目标(例如“用户下单后3秒内返回库存校验结果”),下面写已知限制(例如“不调用订单服务,仅查缓存+本地DB”)。

分段生成模块描述

方法一:按DDD限界上下文切分
先让AI生成“库存上下文”段落→再生成“价格计算上下文”段落→最后生成“跨上下文事件契约”段落。每段开头必须带标题层级(## 库存上下文),结尾空一行。

方法二:用表格驱动结构
在提示词中直接给出Markdown表格框架:
| 模块 | 职责 | 依赖服务 | 幂等性保障 |
|------|------|----------|------------|
然后要求AI只填充内容行,不改表头、不加额外说明。

插入可执行的伪代码片段

对关键路径,用```pseudo包裹伪代码,并在提示词中指定格式:“用动宾短语开头,如‘校验SKU是否存在’‘转换价格单位为分’‘抛出InventoryNotAvailableError’”。

Markdown to PDF (Styled)
Markdown to PDF (Styled)

使用pandoc和wkhtmltopdf将Markdown文件转换为带样式的PDF,支持内置或自定义CSS样式。

下载

这一步不能省略语言标记,必须写```pseudo,否则Fitten Code可能默认渲染成Python或JSON,导致缩进错乱、关键字高亮失效。

生成后立刻检查伪代码里是否出现真实函数名(如getRedisClient())——如有,手动替换成抽象动作(如“从缓存读取”),避免绑定具体实现。

生成接口定义章节

第一步:输入指令“生成OpenAPI 3.0格式的/v1/order/validate接口定义,请求体含sku_id、quantity,响应体含available、locked、reason”。

第二步:复制生成的YAML,在Fitten Code中新建文件,命名为openapi-validate.yaml,粘贴后保存。

第三步:回到原对话,输入“基于openapi-validate.yaml,生成对应的Go结构体定义,使用json tag,字段名用小驼峰”。【注意:必须强调‘小驼峰’,否则AI默认输出大驼峰,导致反序列化失败】

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

fitten code markdown

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

2026.10.08

40

20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

140

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

140

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

100

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

100

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

120

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

320

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

220

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

180

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Fitten Code官方手册
Fitten Code官方手册

共0课时 | 0人学习

Markdown标记语言快速入门
Markdown标记语言快速入门

共30课时 | 4.4万人学习