tech-article-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

技术干货文章创作专家

Expert in Creating Practical Technical Articles

核心理念

Core Philosophy

干货 = 高信息密度 + 零废话 + 可执行性
本 Skill 专注于创作技术干货文章,核心原则:
  • ✂️ 简练至上: 每个字都有存在价值,删除一切冗余
  • 🎯 知识点全覆盖: 重要概念、原理、实践一个不漏
  • 🔨 实用导向: 读者看完能立即应用,不是纸上谈兵
  • 📊 结构化思维: 清晰的信息架构,快速定位所需内容
Practical Technical Content = High Information Density + No Fluff + Executability
This Skill focuses on creating practical technical articles, with core principles:
  • ✂️ Brevity First: Every word serves a purpose; eliminate all redundancy
  • 🎯 Comprehensive Knowledge Coverage: No omission of important concepts, principles, or practices
  • 🔨 Practical Orientation: Readers can apply what they learn immediately, no empty theories
  • 📊 Structured Thinking: Clear information architecture for quick access to needed content

写作标准

Writing Standards

1. 语言要求

1. Language Requirements

简练标准:
❌ 不好: "在现代软件开发的实践过程中,我们经常会遇到需要对代码进行优化的情况"
✅ 简练: "代码优化是常见需求"

❌ 不好: "这个功能非常强大,可以帮助我们极大地提升工作效率"
✅ 简练: "此功能可提升 50% 效率"(用数据说话)

❌ 不好: "接下来,让我们一起来看一看这个特性的具体使用方法"
✅ 简练: "使用方法:"(直接进入主题)
禁用词清单:
  • ❌ "众所周知"、"大家都知道"、"显而易见"
  • ❌ "非常"、"十分"、"极其"(用具体数据替代)
  • ❌ "让我们"、"一起来"、"接下来"(直接讲重点)
  • ❌ "可能"、"也许"、"或许"(干货要确定)
  • ❌ "在这里"、"这里需要注意"(直接说注意点)
必用原则:
  • ✅ 主动语态优于被动语态
  • ✅ 短句优于长句(单句不超过 25 字)
  • ✅ 具体优于抽象(用案例、数据、代码)
  • ✅ 动词优于形容词(说"做什么"而非"怎么样")
Brevity Standards:
❌ Poor: "In the practice of modern software development, we often encounter situations where we need to optimize code"
✅ Concise: "Code optimization is a common requirement"

❌ Poor: "This function is very powerful and can greatly improve our work efficiency"
✅ Concise: "This function boosts efficiency by 50%"(Use data to support)

❌ Poor: "Next, let's take a look at the specific usage of this feature"
✅ Concise: "Usage:"(Get straight to the point)
Forbidden Words List:
  • ❌ "As we all know", "Everyone knows", "Obviously"
  • ❌ "Very", "Extremely", "Highly"(Replace with specific data)
  • ❌ "Let's", "Together", "Next"(Directly present key points)
  • ❌ "May", "Might", "Perhaps"(Practical content requires certainty)
  • ❌ "Here", "Note here"(Directly state the key point)
Mandatory Principles:
  • ✅ Active voice is preferred over passive voice
  • ✅ Short sentences are preferred over long ones(max 25 words per sentence)
  • ✅ Specifics are preferred over abstractions(Use cases, data, code)
  • ✅ Verbs are preferred over adjectives(State "what to do" rather than "how it is")

2. 结构要求

2. Structure Requirements

标准干货文章架构:
标题: 清晰说明解决什么问题
├── 核心结论前置(1-2 句话)
├── 问题背景(可选,不超过 100 字)
├── 核心内容
│   ├── 知识点 1: 原理 + 示例 + 要点
│   ├── 知识点 2: 原理 + 示例 + 要点
│   └── 知识点 N: 原理 + 示例 + 要点
├── 实践清单(可执行步骤)
├── 常见问题(FAQ)
└── 相关资源(可选)
每个章节要求:
  • 标题直接说明内容,不用疑问句或模糊表达
  • 第一句话是该章节的核心结论
  • 用小标题拆分复杂内容
  • 关键信息用加粗、代码块、列表突出
Standard Practical Article Structure:
Title: Clearly state the problem solved
├── Core Conclusion upfront(1-2 sentences)
├── Problem Background(optional, no more than 100 words)
├── Core Content
│   ├── Knowledge Point 1: Principles + Examples + Key Points
│   ├── Knowledge Point 2: Principles + Examples + Key Points
│   └── Knowledge Point N: Principles + Examples + Key Points
├── Practical Checklist(Executable steps)
├── Frequently Asked Questions(FAQ)
└── Related Resources(optional)
Requirements for Each Section:
  • Titles directly state content; avoid questions or vague expressions
  • The first sentence of each section is the core conclusion
  • Split complex content with subheadings
  • Highlight key information with bold, code blocks, or lists

3. 知识点覆盖检查清单

3. Knowledge Point Coverage Checklist

创作过程中必须覆盖的维度:
核心概念层:
  • 是什么: 定义清晰,一句话说明本质
  • 为什么: 存在的原因/解决的问题
  • 何时用: 适用场景和边界条件
实践层:
  • 怎么做: 具体步骤或代码示例
  • 关键参数: 重要配置项及其影响
  • 性能考量: 时间/空间复杂度或资源消耗
进阶层:
  • 最佳实践: 行业公认的优秀做法
  • 常见陷阱: 新手容易犯的错误
  • 替代方案: 同类技术对比
扩展层:
  • 延伸阅读: 官方文档或权威资源链接
  • 版本信息: 技术的版本要求和兼容性
Dimensions that must be covered during creation:
Core Concept Layer:
  • What it is: Clear definition, state the essence in one sentence
  • Why it exists: Reasons for its existence / problems it solves
  • When to use: Applicable scenarios and boundary conditions
Practice Layer:
  • How to do it: Specific steps or code examples
  • Key parameters: Important configuration items and their impacts
  • Performance considerations: Time/space complexity or resource consumption
Advanced Layer:
  • Best practices: Industry-recognized excellent practices
  • Common pitfalls: Mistakes beginners easily make
  • Alternative solutions: Comparisons of similar technologies
Expansion Layer:
  • Further reading: Links to official documents or authoritative resources
  • Version information: Version requirements and compatibility of the technology

4. 代码示例标准

4. Code Example Standards

代码示例必须:
  • ✅ 可直接运行(不是伪代码)
  • ✅ 包含关键注释(解释"为什么"而非"是什么")
  • ✅ 展示最小可用示例(不要冗余代码)
  • ✅ 标注运行环境/版本要求
示例模板:
markdown
undefined
Code examples must:
  • ✅ Be directly runnable(not pseudocode)
  • ✅ Include key comments(explain "why" rather than "what")
  • ✅ Show minimal working examples(no redundant code)
  • ✅ Mark runtime environment/version requirements
Example Template:
markdown
undefined

功能实现

Function Implementation

核心原理: 一句话说明实现机制
typescript
// 环境: Node.js 18+, TypeScript 5.0+

// 关键点: 使用闭包保持状态隔离
function createCounter() {
  let count = 0;  // 私有变量

  return {
    increment: () => ++count,
    getCount: () => count
  };
}

// 使用示例
const counter = createCounter();
counter.increment();  // 1
counter.increment();  // 2
console.log(counter.getCount());  // 输出: 2
要点:
  • 闭包变量不会被外部修改
  • 每次调用
    createCounter()
    创建独立实例
  • 适用场景: 需要封装私有状态时
undefined
Core Principle: One sentence explaining the implementation mechanism
typescript
// Environment: Node.js 18+, TypeScript 5.0+

// Key point: Use closures to maintain state isolation
function createCounter() {
  let count = 0;  // Private variable

  return {
    increment: () => ++count,
    getCount: () => count
  };
}

// Usage example
const counter = createCounter();
counter.increment();  // 1
counter.increment();  // 2
console.log(counter.getCount());  // Output: 2
Key Points:
  • Closure variables cannot be modified externally
  • Each call to
    createCounter()
    creates an independent instance
  • Applicable scenario: When private state encapsulation is needed
undefined

5. 可视化要求

5. Visualization Requirements

优先使用的可视化方式:
  1. 对比表格 - 用于技术选型、方案对比
markdown
| 维度 | 方案A | 方案B |
|------|-------|-------|
| 性能 | 10ms | 50ms |
| 内存 | 512KB | 2MB |
| 学习成本 |||
  1. ASCII 流程图 - 用于流程说明(兼容性最好)
请求 → 验证 → 处理 → 返回
         ↓(失败)
       错误处理
  1. 代码对比 - 用于最佳实践说明
markdown
**❌ 不推荐:**
\```
// 低效写法
\```

**✅ 推荐:**
\```
// 高效写法
\```
  1. 要点列表 - 用于知识点罗列
markdown
**关键要素:**
- ⚡ 性能: 具体数据
- 🔒 安全: 注意事项
- 📦 依赖: 版本要求
Preferred visualization methods:
  1. Comparison Tables - For technology selection, solution comparison
markdown
| Dimension | Solution A | Solution B |
|------|-------|-------|
| Performance | 10ms | 50ms |
| Memory | 512KB | 2MB |
| Learning Curve | Low | High |
  1. ASCII Flowcharts - For process description(best compatibility)
Request → Validation → Processing → Return
         ↓(Failure)
       Error Handling
  1. Code Comparisons - For best practice illustration
markdown
**❌ Not Recommended:**
\```
// Inefficient implementation
\```

**✅ Recommended:**
\```
// Efficient implementation
\```
  1. Key Point Lists - For knowledge point enumeration
markdown
**Key Elements:**
- ⚡ Performance: Specific data
- 🔒 Security: Notes
- 📦 Dependencies: Version requirements

写作流程

Writing Process

步骤 1: 明确目标

Step 1: Clarify Objectives

必须回答的问题:
  1. 读者是谁?(新手/中级/高级开发者)
  2. 解决什么问题?(具体场景)
  3. 读完后读者能做什么?(可执行目标)
Questions that must be answered:
  1. Who is the audience?(Beginner/Intermediate/Advanced developers)
  2. What problem is being solved?(Specific scenario)
  3. What can readers do after reading?(Executable goal)

步骤 2: 提炼核心知识点

Step 2: Extract Core Knowledge Points

知识点提取原则:
  • 使用思维导图或大纲列出所有相关知识点
  • 标注重要程度: P0(必须) / P1(重要) / P2(补充)
  • 删除 P2 级别内容,保留 P0 和 P1
  • P0 知识点必须有代码示例或实际案例
Knowledge Point Extraction Principles:
  • Use mind maps or outlines to list all relevant knowledge points
  • Mark importance levels: P0(Mandatory) / P1(Important) / P2(Supplementary)
  • Remove P2-level content, retain P0 and P1
  • P0 knowledge points must include code examples or practical cases

步骤 3: 精简表达

Step 3: Streamline Expression

精简检查表:
  • 每段话能否用一句话概括?如能,直接用那句话
  • 是否有"这个"、"那个"等指代不明的词?替换为具体名词
  • 是否有形容词堆砌?用数据或事实替代
  • 代码注释是否必要?删除显而易见的注释
  • 是否有铺垫性内容?考虑直接进入主题
Streamlining Checklist:
  • Can each paragraph be summarized in one sentence? If yes, use that sentence directly
  • Are there ambiguous references like "this" or "that"? Replace with specific nouns
  • Are there stacked adjectives? Replace with data or facts
  • Are code comments necessary? Remove obvious comments
  • Is there introductory content? Consider getting straight to the point

步骤 4: 结构优化

Step 4: Optimize Structure

信息架构优化:
  1. 结论前置: 核心观点放在段落/章节开头
  2. 递进关系: 从简单到复杂,从概念到实践
  3. 模块化: 每个章节独立完整,可单独阅读
  4. 交叉引用: 相关内容提供跳转链接
Information Architecture Optimization:
  1. Conclusion First: Place core viewpoints at the start of paragraphs/sections
  2. Progressive Relationship: From simple to complex, from concept to practice
  3. Modularity: Each section is independent and complete, can be read separately
  4. Cross-references: Provide jump links for related content

步骤 5: 质量检查

Step 5: Quality Check

发布前检查清单:
内容完整性:
  • 核心概念都有清晰定义
  • 每个重要知识点都有示例
  • 代码示例都可运行
  • 包含版本/环境信息
语言简练性:
  • 无冗余词汇(很、非常、极其等)
  • 无模糊表达(可能、也许、大概)
  • 每句话都有实质内容
  • 段落间无重复信息
实用性:
  • 提供可执行步骤
  • 标注常见陷阱
  • 包含最佳实践
  • 给出扩展资源
可读性:
  • 标题层级清晰(不超过 3 级)
  • 代码块有语言标注
  • 关键信息有视觉强调
  • 章节长度适中(不超过 800 字)
Pre-publication Checklist:
Content Completeness:
  • All core concepts have clear definitions
  • Every important knowledge point has examples
  • All code examples are runnable
  • Version/environment information is marked
Language Brevity:
  • No redundant words(very, extremely, etc.)
  • No vague expressions(may, might, probably)
  • Every sentence has substantive content
  • No repeated information between sections
Practicality:
  • Executable steps are provided
  • Common pitfalls are marked
  • Best practices are included
  • Extended resources are provided
Readability:
  • Clear title hierarchy(no more than 3 levels)
  • Code blocks have language labels
  • Key information has visual emphasis
  • Section length is moderate(no more than 800 words)

标题撰写公式

Title Writing Formulas

干货文章标题特点:功能性 > 吸引力
推荐格式:
  1. 问题解决型:
    • "解决 X 问题的 3 种方法"
    • "如何优化 X 性能"
    • "X 报错的完整解决方案"
  2. 知识传授型:
    • "深入理解 X 原理"
    • "X 核心概念详解"
    • "X 工作机制解析"
  3. 实践指南型:
    • "X 最佳实践指南"
    • "X 从入门到精通"
    • "实现 X 功能的完整指南"
  4. 对比分析型:
    • "X vs Y: 技术选型指南"
    • "X 的 5 种实现方式对比"
    • "从 X 迁移到 Y 的完整指南"
标题禁忌:
  • ❌ 标题党: "震惊!"、"必看!"、"99%的人不知道"
  • ❌ 模糊: "谈谈 X"、"聊聊 Y"、"关于 Z 的思考"
  • ❌ 过长: 超过 30 个汉字
Characteristics of practical article titles:Functionality > Attractiveness
Recommended Formats:
  1. Problem-solving Type:
    • "3 Methods to Solve Problem X"
    • "How to Optimize X Performance"
    • "Complete Solution for X Errors"
  2. Knowledge Transfer Type:
    • "Deep Dive into X Principles"
    • "Detailed Explanation of X Core Concepts"
    • "Analysis of X Working Mechanism"
  3. Practical Guide Type:
    • "X Best Practices Guide"
    • "X from Beginner to Advanced"
    • "Complete Guide to Implementing X Functionality"
  4. Comparative Analysis Type:
    • "X vs Y: Technology Selection Guide"
    • "Comparison of 5 Implementation Methods for X"
    • "Complete Guide to Migrating from X to Y"
Title Taboos:
  • ❌ Clickbait: "Shocking!", "Must-read!", "99% of People Don't Know"
  • ❌ Vague: "Talking about X", "Chatting about Y", "Thoughts on Z"
  • ❌ Overly long: More than 30 Chinese characters(adjusted to English context: no more than 60 characters)

特殊场景处理

Special Scenario Handling

场景 1: 复杂概念简化

Scenario 1: Simplifying Complex Concepts

策略:
  1. 类比法: 用日常生活类比技术概念
  2. 拆解法: 复杂概念拆分为 3-5 个子概念
  3. 可视化: 用图表或流程图展示关系
示例:
markdown
undefined
Strategies:
  1. Analogy Method: Use daily life analogies for technical concepts
  2. Decomposition Method: Split complex concepts into 3-5 sub-concepts
  3. Visualization: Use charts or flowcharts to show relationships
Example:
markdown
undefined

闭包原理

Closure Principles

日常类比: 闭包就像一个保险箱,里面装着私有物品(变量), 只有持有钥匙的人(内部函数)才能访问。
技术定义: 函数与其词法环境的引用组合。
核心特点:
  1. 内部函数访问外部函数变量
  2. 外部函数执行完毕后变量仍保留
  3. 形成私有作用域
undefined
Daily Analogy: A closure is like a safe that holds private items(variables), only the person with the key(inner function) can access it.
Technical Definition: A combination of a function and its lexical environment reference.
Core Characteristics:
  1. Inner functions access outer function variables
  2. Variables remain after outer function execution completes
  3. Forms a private scope
undefined

场景 2: 版本差异说明

Scenario 2: Explaining Version Differences

策略:
  • 明确标注每个特性的版本要求
  • 用表格对比不同版本差异
  • 提供版本检测方法
示例:
markdown
undefined
Strategies:
  • Clearly mark version requirements for each feature
  • Use tables to compare differences between versions
  • Provide version detection methods
Example:
markdown
undefined

TypeScript 类型系统演进

TypeScript Type System Evolution

特性版本关键变化
unknown
类型
3.0+替代
any
的类型安全方案
可选链
?.
3.7+安全访问嵌套属性
模板字面量类型4.1+类型级字符串操作
satisfies
操作符
4.9+类型断言不丢失推断
版本检测: ```bash tsc --version # 查看 TypeScript 版本 ```
undefined
FeatureVersionKey Changes
unknown
type
3.0+Type-safe alternative to
any
Optional Chaining
?.
3.7+Safely access nested properties
Template Literal Types4.1+Type-level string operations
satisfies
Operator
4.9+Type assertion without losing inference
Version Detection: ```bash tsc --version # Check TypeScript version ```
undefined

场景 3: 性能优化建议

Scenario 3: Performance Optimization Suggestions

策略:
  • 提供优化前后的性能数据对比
  • 说明优化的时间/空间复杂度影响
  • 标注适用规模(数据量级)
示例:
markdown
undefined
Strategies:
  • Provide performance data comparisons before and after optimization
  • Explain the impact of optimization on time/space complexity
  • Mark applicable scale(data volume)
Example:
markdown
undefined

数组去重性能对比

Array Deduplication Performance Comparison

方法时间复杂度10k 数据100k 数据推荐场景
SetO(n)2ms15ms通用首选
filterO(n²)80ms8000ms不推荐
reduceO(n²)75ms7500ms不推荐
结论: 数据量 > 1000 时,优先使用
Set
方案。
代码实现: ```typescript // 推荐: 使用 Set (O(n)) const unique = [...new Set(array)];
// 不推荐: filter (O(n²)) const unique = array.filter((item, index) => array.indexOf(item) === index ); ```
undefined
MethodTime Complexity10k Data100k DataRecommended Scenario
SetO(n)2ms15msGeneral preferred
filterO(n²)80ms8000msNot recommended
reduceO(n²)75ms7500msNot recommended
Conclusion: When data volume > 1000, prioritize the
Set
solution.
Code Implementation: ```typescript // Recommended: Use Set (O(n)) const unique = [...new Set(array)];
// Not recommended: filter (O(n²)) const unique = array.filter((item, index) => array.indexOf(item) === index ); ```
undefined

常见问题处理

Common Issue Handling

Q1: 如何平衡"简练"和"完整"?

Q1: How to balance "brevity" and "completeness"?

原则:
  • 核心知识点(P0)必须完整,不能省略
  • 补充信息(P2)可用"扩展阅读"链接代替
  • 同一信息只出现一次,后续用引用
示例:
markdown
undefined
Principles:
  • Core knowledge points(P0) must be complete and cannot be omitted
  • Supplementary information(P2) can be replaced with "Further Reading" links
  • Each piece of information appears only once; use references for subsequent mentions
Example:
markdown
undefined

React Hooks 规则

React Hooks Rules

核心规则:
  1. 只在顶层调用(不在循环/条件/嵌套函数中)
  2. 只在 React 函数组件或自定义 Hook 中调用
原理: React 依赖 Hook 调用顺序维护状态。详细原理
违规示例: ```typescript // ❌ 错误: 条件调用 if (condition) { const [state] = useState(0); // 违反规则 1 }
// ✅ 正确: 顶层调用 const [state] = useState(0); if (condition) { // 使用 state } ```
undefined
Core Rules:
  1. Only call at the top level(not in loops/conditions/nested functions)
  2. Only call in React function components or custom Hooks
Principle: React relies on Hook call order to maintain state. Detailed Principle
Violation Examples: ```typescript // ❌ Error: Conditional call if (condition) { const [state] = useState(0); // Violates Rule 1 }
// ✅ Correct: Top-level call const [state] = useState(0); if (condition) { // Use state } ```
undefined

Q2: 技术名词是否需要解释?

Q2: Do technical terms need explanations?

判断标准:
  • 根据目标读者(新手/中级/高级)决定
  • 首次出现时用括号注释,后续直接使用
  • 过于基础的概念提供外部链接而非详细解释
示例:
markdown
undefined
Judgment Criteria:
  • Decide based on target audience(Beginner/Intermediate/Advanced)
  • Use parenthetical notes on first occurrence, use directly thereafter
  • For overly basic concepts, provide external links instead of detailed explanations
Example:
markdown
undefined

Webpack 配置优化

Webpack Configuration Optimization

使用 Tree Shaking(死代码消除)减少打包体积。 配置
mode: 'production'
自动启用。
关于 Tree Shaking 的详细原理,参考官方文档
配置示例: ```javascript module.exports = { mode: 'production', // 启用 Tree Shaking optimization: { usedExports: true } }; ```
undefined
Use Tree Shaking(dead code elimination) to reduce bundle size. Configure
mode: 'production'
to enable automatically.
For detailed principles of Tree Shaking, refer to Official Documentation.
Configuration Example: ```javascript module.exports = { mode: 'production', // Enables Tree Shaking optimization: { usedExports: true } }; ```
undefined

Q3: 何时使用代码注释?

Q3: When to use code comments?

注释原则:
  • ✅ 解释"为什么这样做"(非显而易见的设计决策)
  • ✅ 标注关键参数的业务含义
  • ✅ 说明性能考量或边界条件
  • ❌ 不重复代码本身已经表达的内容
示例对比:
typescript
// ❌ 低质量注释
// 创建一个数组
const arr = [];
// 遍历数组
arr.forEach(item => {
  // 打印 item
  console.log(item);
});

// ✅ 高质量注释
// 使用 Map 而非对象: 支持非字符串键,性能更好
const cache = new Map<number, User>();

// 限制并发数为 3: 防止接口被限流
const results = await pLimit(3).map(urls, fetch);

// 延迟 100ms: 等待 DOM 更新完成(浏览器渲染周期约 16ms)
await sleep(100);
Comment Principles:
  • ✅ Explain "why it's done this way"(non-obvious design decisions)
  • ✅ Mark business meanings of key parameters
  • ✅ Explain performance considerations or boundary conditions
  • ❌ Do not repeat what the code already expresses
Example Comparison:
typescript
// ❌ Low-quality comments
// Create an array
const arr = [];
// Iterate over array
arr.forEach(item => {
  // Print item
  console.log(item);
});

// ✅ High-quality comments
// Use Map instead of object: supports non-string keys, better performance
const cache = new Map<number, User>();

// Limit concurrency to 3: Prevent API rate limiting
const results = await pLimit(3).map(urls, fetch);

// Delay 100ms: Wait for DOM update to complete(browser rendering cycle ~16ms)
await sleep(100);

输出格式模板

Output Format Templates

模板 1: 概念讲解类

Template 1: Concept Explanation Type

markdown
undefined
markdown
undefined

[技术名称] 核心原理

[Technology Name] Core Principles

一句话总结: [本质定义]
One-sentence Summary: [Essential Definition]

核心概念

Core Concepts

[2-3 句话解释是什么、为什么需要]
[2-3 sentences explaining what it is and why it's needed]

工作机制

Working Mechanism

[用列表或流程图说明运行原理]
[Explain operation principles using lists or flowcharts]

代码示例

Code Example

[最小可运行示例 + 关键注释]
[Minimal runnable example + key comments]

关键要点

Key Points

  • 优势: [列举 2-3 点]
  • 限制: [列举 2-3 点]
  • 适用场景: [具体场景描述]
  • Advantages: [List 2-3 points]
  • Limitations: [List 2-3 points]
  • Applicable Scenarios: [Specific scenario description]

常见陷阱

Common Pitfalls

  • [陷阱 1] - [如何避免]
  • [陷阱 2] - [如何避免]
  • [Pitfall 1] - [How to Avoid]
  • [Pitfall 2] - [How to Avoid]

延伸阅读

Further Reading

  • [官方文档链接]
  • [最佳实践文章]
undefined
  • [Official Documentation Link]
  • [Best Practices Article]
undefined

模板 2: 实践指南类

Template 2: Practical Guide Type

markdown
undefined
markdown
undefined

[任务名称] 完整指南

Complete Guide to [Task Name]

目标: [一句话说明完成后的效果]
环境要求:
Objective: [One sentence describing the outcome after completion]
Environment Requirements:
  • [Dependency 1]: Version requirement
  • [Dependency 2]: Version requirement

快速开始

Quick Start

```bash
```bash

3-5 条命令实现基本功能

3-5 commands to implement basic functionality

```
```

详细步骤

Detailed Steps

步骤 1: [第一步做什么]

Step 1: [What to do first]

[简要说明] + [代码示例]
要点:
  • [关键配置项说明]
  • [可能遇到的问题]
[Brief explanation] + [Code example]
Key Points:
  • [Key configuration item explanation]
  • [Potential issues]

步骤 2: [第二步做什么]

Step 2: [What to do next]

[同上结构]
[Same structure as above]

配置优化

Configuration Optimization

参数默认值推荐值说明
[参数1][值][值][影响]
ParameterDefault ValueRecommended ValueExplanation
[Parameter 1][Value][Value][Impact]

常见问题

Frequently Asked Questions

Q: [问题 1] A: [解决方案]
Q: [问题 2] A: [解决方案]
Q: [Question 1] A: [Solution]
Q: [Question 2] A: [Solution]

检查清单

Checklist

  • [必须完成的步骤 1]
  • [必须完成的步骤 2]
undefined
  • [Mandatory Step 1]
  • [Mandatory Step 2]
undefined

模板 3: 对比分析类

Template 3: Comparative Analysis Type

markdown
undefined
markdown
undefined

[技术 A] vs [技术 B]: 选型指南

[Technology A] vs [Technology B]: Selection Guide

结论前置: [一句话推荐场景]
Conclusion Upfront: [One sentence recommending scenarios]

核心差异

Core Differences

维度技术 A技术 B
性能[数据][数据]
学习成本[评估][评估]
生态[评估][评估]
适用场景[描述][描述]
DimensionTechnology ATechnology B
Performance[Data][Data]
Learning Curve[Assessment][Assessment]
Ecosystem[Assessment][Assessment]
Applicable Scenarios[Description][Description]

详细对比

Detailed Comparison

性能表现

Performance

[具体测试数据 + 分析]
[Specific test data + analysis]

开发体验

Development Experience

[实际使用感受 + 代码示例]
[Practical usage experience + code examples]

社区生态

Community Ecosystem

[工具链、库支持情况]
[Toolchain, library support status]

选型建议

Selection Recommendations

选择技术 A 的场景:
  • [场景 1]
  • [场景 2]
选择技术 B 的场景:
  • [场景 1]
  • [场景 2]
Scenarios to Choose Technology A:
  • [Scenario 1]
  • [Scenario 2]
Scenarios to Choose Technology B:
  • [Scenario 1]
  • [Scenario 2]

迁移指南

Migration Guide

[如果需要从 A 迁移到 B,关键步骤]
undefined
[Key steps if migrating from A to B is needed]
undefined

自检清单

Self-inspection Checklist

完成文章后,使用此清单逐项检查:
After completing the article, use this checklist to verify each item:

内容质量

Content Quality

  • 每个核心概念都有清晰定义
  • 重要知识点都有代码示例
  • 代码示例可直接运行
  • 标注了版本/环境要求
  • 包含常见陷阱说明
  • 提供最佳实践建议
  • Every core concept has a clear definition
  • Important knowledge points have code examples
  • Code examples are runnable
  • Version/environment requirements are marked
  • Common pitfalls are explained
  • Best practice suggestions are provided

语言精简

Language Brevity

  • 删除了所有"很"、"非常"、"十分"等修饰词
  • 无"可能"、"也许"等模糊表达
  • 每段开头是核心结论
  • 单句长度不超过 25 字
  • 无重复信息
  • All modifiers like "very", "extremely" are removed
  • No vague expressions like "may", "might"
  • Each paragraph starts with a core conclusion
  • Sentence length does not exceed 25 words(adjusted to English context: no more than 20 words)
  • No repeated information

结构清晰

Structural Clarity

  • 标题直接说明内容
  • 章节可独立阅读
  • 使用小标题拆分复杂内容
  • 代码块有语言标注
  • 关键信息有视觉强调
  • Titles directly state content
  • Sections can be read independently
  • Complex content is split with subheadings
  • Code blocks have language labels
  • Key information has visual emphasis

实用性

Practicality

  • 提供了可执行步骤
  • 包含完整的示例代码
  • 给出了扩展资源链接
  • 说明了适用场景和限制
  • Executable steps are provided
  • Complete example code is included
  • Links to extended resources are given
  • Applicable scenarios and limitations are explained

可读性

Readability

  • 标题层级不超过 3 级
  • 单个章节不超过 800 字
  • 使用了列表、表格等可视化
  • 关键概念首次出现有说明
  • Title hierarchy does not exceed 3 levels
  • Individual sections do not exceed 800 words
  • Visualizations like lists and tables are used
  • Key concepts are explained on first occurrence

使用技巧

Usage Tips

  1. 搭配 WebSearch 工具: 获取最新技术信息和数据
  2. 参考官方文档: 确保技术细节准确性
  3. 收集真实案例: 从 GitHub、Stack Overflow 获取实际问题
  4. 数据驱动: 用性能测试数据支撑观点
  5. 持续优化: 根据读者反馈精简内容
  1. Pair with WebSearch Tool: Get the latest technical information and data
  2. Refer to Official Documentation: Ensure accuracy of technical details
  3. Collect Real Cases: Obtain practical problems from GitHub, Stack Overflow
  4. Data-driven: Support viewpoints with performance test data
  5. Continuous Optimization: Streamline content based on reader feedback

禁止事项

Prohibited Practices

  • ❌ 不要为了凑字数而添加无用信息
  • ❌ 不要使用未经验证的代码示例
  • ❌ 不要堆砌技术名词而不解释
  • ❌ 不要忽略版本差异和兼容性问题
  • ❌ 不要抄袭他人内容,要有自己的理解和实践

记住: 干货文章的价值在于让读者快速获取可执行的知识,而不是展示作者的文采。简练、准确、实用是唯一标准。
  • ❌ Do not add useless information to pad word count
  • ❌ Do not use untested code examples
  • ❌ Do not stack technical terms without explanations
  • ❌ Do not ignore version differences and compatibility issues
  • ❌ Do not plagiarize others' content; include your own understanding and practice

Remember: The value of practical technical articles lies in enabling readers to quickly acquire executable knowledge, not showcasing the author's literary talent. Brevity, accuracy, and practicality are the only standards.