type
status
date
slug
summary
tags
category
icon
password
前公司上司推荐的书，这本书介绍了如何编写易于检索、易于让人理解的文档，在此记录读书总结。
第1章 概述
内容要精简：
1.内容要精选到必要的东西一个不漏，没用的东西一个不写
2.确认一句话是不是不会被读出两个意思
3.要点要短，形成只有标题的提纲
结构要明晰：
1.要把事实和观点分段，避免导致不当推论
2.顺序要自然，要结合读者接下来想读什么的心情
3.做复杂的分析时，把统计资料放在附录里
语言要易懂：
1.斩钉截铁说明白，不要用［仿佛］之类的词
2.不要用不是所有人都看得懂的词
3.不要混入任何感情色彩，不要写［注意这些是很重要的］之类的日常性废话
第2章 写文准备
带着明确的目标写
首先反省一下写这篇文章的目的，或文章的用途，或读者会期待什么，
如：经费申请书必须传递的是研究的价值和可能性，就要明确阐述研究目的，自己到现在为止做了什么，将来要做什么，让评审专家一目了然地判断成功的概率
要理解文章的主题是什么
一个文章只选定一个主题，并使用限定的篇幅编写
在讨论某个问题时先梳理
为什么这会成为一个问题，关于这个问题已经确实明白了什么，需要调查/讨论的是什么
然后再进行讨论
第3章 文章结构
开头和结尾部分
1.第一段首先像新闻那样说重点（包括结论），让读者了解主要内容，判断读不读
即，简要概括［本篇文章要介绍的是xxxxx］
2.紧跟着是序论部分描述背景知识：
顺序不一定重要，但要突出的是：问题的背景是、要解决什么问题、提出这个问题的动机是什么、为什么这个问题很重要、为什么这个问题很重要准备用什么手段解决这个问题
3.若要写结尾部分，就罗列本文的几个重点，强调起重要性或将来性
内容本身
- 以系统说明为例，先宏观描述系统的整体工作机制（可以分为两三个部分），然后逐个展开
- 微观描写每个部分时，首先决定按照什么顺序描写，比如：
- 按空间顺序描写，按时间顺序描写，按性质分类顺序描写
- 在开始写文章前，先定好这个顺序，如果要调整排序方式，则重写整个文章
- 事先决定逻辑展开的顺序
- 先举反对意见再批判，还是先描述自己的意见在论破其他意见？
- 先举很多事例再提出主张，还是先提出主张再举出例证？
- 事先列出文档各个部分标题的结构图
第4章 段落
根据话题分段落
每一段的第一句写明这一段的主题（主题句）
展开部分不要写不符合主题句的话
- 错误例子：主题句是“对没有经验的人来说游泳很危险”，第二句是“我家附近有很多好的游泳地点”
第5章 内容结构
做到读到这里就懂到这里，而不要让人先读完整个文章
不要有思维上的跳跃，不要期待人脑补
避免针对主干名词写很长的前置修饰语，如果有多处前置修饰语会让人觉得文章脉络衔接很差，要把主干语提到段落开头（即便是做翻译）
第6章 把话说明白
用肯定的措辞，不要搞日式的缓冲语法
想保留其他不确定性的时候，可以写脚注
把要传达的内容本身写清楚，不要留下脑补的余白
第7章 事实和意见
详细区分的话，还能分为【陈述事实 引用理论 / 推论 判断 意见 坚信 假设】等
最保险的方法是把陈述事实的部分和主观的部分分开写，并且从语法/用词上能够区分这几项
在陈述主观内容时，一定要注意是否和客观事实部分相冲突，以及客观事实部分是否能充分支持主观部分
第8章 简洁表现
把长文拆成多个含义单一的短句
把各个短句适当地连接起来，而不要一气呵成
随时意识每句话主语和强调的主体