技术写作技巧
写作前的准备
明确目标读者
- 初学者?
- 有经验的开发者?
- 决策者?
确定文章结构
- 问题/背景
- 解决方案
- 实践步骤
- 总结
写作原则
简洁明了
- 使用短句
- 删除冗余词汇
- 一个段落一个主题
代码示例
// 好的示例:有注释,有上下文
function greet(name) {
// 检查参数
if (!name) {
throw new Error('Name is required');
}
return `Hello, ${name}!`;
}
视觉元素
- 使用列表和表格
- 添加截图和图表
- 适当使用加粗和斜体