问题描述:
不论科研还是学习,总结文档还是申请文档,写作都是非常重要的。找到一份《科技文档写作建议》,感觉挺有用的,作摘录如下。
写作态度:
01.
把自己放到读者角度,
自己首先检查是否对文档满意。
02.
使文档更漂亮,文档是艺术而不是技术,
学点艺术,学点审美,不仅为工作,也为生活。
03.
自己排版,
科技文档内容与形式紧密相连。自己把格式排到最好,不懂内容很难排好版,既然排版是一门艺术,
then make an art piece, enjoy the process and enjoy the result.
04.
读者在任何时候都是对的,
读者遇到问题,任何时候都应认为是文档问题,而不是读者问题,要立即修改文档,比如修改句式,调整内容先后顺序等。
05.
总是使用最新版的编辑软件,
如:使用
Office 2007
,而不是
Office 2003,
工欲善其事,必先利其器。
06.
花点时间学习编辑软件的使用,
先磨刀,后砍柴。
07.
注重细节,细节决定质量,
如:中英文标点不混用。中文内容使用中文标点,英文内容使用英文标点。
不要有任何多余的空格,虽然空格没有任何影响。
Tip
:
Ctrl+A
即可发现多余空格。
08.
文档检查,
文档写完后看一遍,只要有更改,应再看一遍,直到从头到尾不再发现任何问题。
09. 一切为效率,
效率低,与别人的差距只会越来越大。
You saved time, you saved everything.
写作方式:
01.
科技文档进行大略说明。
02.
内容不可喧宾夺主
。
03.
不使用人称,如:我们,他们。
04.
读者不同,写作方式不同。
05.
语言尽可能简练
。
06.
用词准确
。
07.
若需重复,直接拷贝,以保持相同的句式、内容
读者再次遇到时不需考虑貌似相同的内容究竟有何细节的不同。科技注重细节。
08.
操作顺序合适
。
09.
吹毛求疵的做法,
使用“需”代替“需要”,使用“若”代替“如果”。读来感觉干脆有力。