Chinaunix首页 | 论坛 | 博客
  • 博客访问: 164471
  • 博文数量: 154
  • 博客积分: 0
  • 博客等级: 民兵
  • 技术积分: 1575
  • 用 户 组: 普通用户
  • 注册时间: 2016-12-20 17:02
  • 认证徽章:
文章分类

全部博文(154)

文章存档

2017年(112)

2016年(42)

我的朋友

分类: 服务器与存储

2017-02-07 16:50:53

很多人说,不知道怎么写文档,都是凭着感觉写。

网上也很少有资料,教你写文档。这已经影响了中文软件的发展。

英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软MailChimpAppleYahoodockerStruts 等等(维基百科有一份完整的清单)。中文的也有不少,但都不令人满意,要么太简单,要么不太适用。

我就动手,参考上面的规范,也结合自己的实践,总结了一份简单的《中文技术文档的写作规范》

  1. 标题
  2. 文本
  3. 段落
  4. 数值
  5. 标点符号
  6. 章节结构

我希望,这样可以抛砖引玉,让更多人重视文档,进而真正出现大家普遍接受的文档规范。

下面是关于写作风格的一个片段。欢迎提交 Issue 和 PR 补充。

=================================

写作风格

(摘自《中文技术文档的写作规范》

如果使用了被动语态,应考虑更改为主动语态。


不使用非正式的语言风格。


用对"的"、"地"、"得"。


阅读全文直接点击:http://click.aliyun.com/m/9973/
阅读(377) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~
评论热议
请登录后评论。

登录 注册