feat(appendix): 添加多个交互式演示组件,完善 AI/Infra 等章节内容
- 新增 Vibe Coding 全栈相关演示组件 (DeveloperSkillShift, FrontendTriad, BackendCore 等) - 新增 RAG 相关组件 (RAGPipeline, ChunkingStrategy, Retrieval 等) - 新增 Embedding & Vector 相关组件 (EmbeddingConcept, VectorSimilarity 等) - 新增 AI Native App 设计组件 (AINativeArch, PromptDesign 等) - 新增 Infrastructure as Code 组件 (IaCConcept, TerraformWorkflow 等) - 新增 DNS & HTTPS 演示组件 (DnsResolution, HttpsHandshake 等) - 新增 Model Finetuning 组件 (FinetuningPipeline 等) - 更新多个章节的 markdown 内容,集成交互式演示
This commit is contained in:
@@ -151,7 +151,58 @@ for (let i = items.length - 1; i >= 0; i--) { ... }
|
||||
|
||||
---
|
||||
|
||||
## 5. 总结
|
||||
## 5. AI 助力:用大模型提升文档质量
|
||||
|
||||
大模型在技术写作领域几乎是"天赋异禀"——生成文档、改善表达、翻译内容都是它的强项。
|
||||
|
||||
### 5.1 生成 API 文档
|
||||
|
||||
> **提示词**:
|
||||
> ```
|
||||
> 根据以下 Express 路由代码,生成完整的 API 文档,包括:
|
||||
> - 端点路径和方法
|
||||
> - 请求参数(路径参数、查询参数、请求体)及类型
|
||||
> - 成功和错误的响应示例
|
||||
> - 使用 curl 的调用示例
|
||||
>
|
||||
> [粘贴你的路由代码]
|
||||
> ```
|
||||
|
||||
### 5.2 改善技术写作
|
||||
|
||||
> **提示词**:
|
||||
> ```
|
||||
> 请改善以下技术文档的表达,要求:
|
||||
> 1. 语言简洁清晰,去掉冗余表述
|
||||
> 2. 用主动语态替代被动语态
|
||||
> 3. 专业术语保持准确
|
||||
> 4. 添加必要的代码示例
|
||||
> 保持原意不变,只改善表达质量。
|
||||
>
|
||||
> [粘贴你的文档内容]
|
||||
> ```
|
||||
|
||||
### 5.3 生成 README
|
||||
|
||||
> **提示词**:
|
||||
> ```
|
||||
> 根据以下项目信息,生成一份高质量的 README.md:
|
||||
> - 项目名称:[名称]
|
||||
> - 一句话描述:[描述]
|
||||
> - 技术栈:[列出]
|
||||
> - 核心功能:[列出]
|
||||
>
|
||||
> 要求包含:项目简介、快速开始、功能特性、
|
||||
> 安装步骤(含代码)、使用示例、贡献指南、许可证。
|
||||
> ```
|
||||
|
||||
::: tip AI 使用建议
|
||||
AI 生成的文档要检查技术细节是否准确——它可能编造不存在的 API 参数或错误的返回值。始终对照实际代码验证。
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## 6. 总结
|
||||
|
||||
1. **类型匹配**:不同文档有不同的结构和写法
|
||||
2. **清晰优先**:具体、准确、面向读者
|
||||
|
||||
Reference in New Issue
Block a user