管理感悟：掌握写文档的技能
管理感悟：掌握写文档的技能
红朝儒生
2016-5-3
关键字：管理 文档 程序员
简介：程序是汝之工作产出，文档亦是。写好文档，是每个管理者、程序高手的必备技能。
吾在软件行业混了这么多年，经历多，感受也多。其中一个比较深刻的体会是：很少有程序员掌握写文档的技能。
什么叫写文档的技能？吾以为有几层含义：
写什么样子的文档。是文章？表格？幻灯片？
文档的基本概念。比如，要有作者、时间，合理分段（段落不要太长），开头缩进，使用表格表达某些内容。这些是小学生就应该掌握的技能，大多数程序员都不会。
使用必要的文档技术，比如：项目编号，缩进，标题，目录，页眉页脚，自选图形等，字体段落。
吾自认写文档的技能实在一般。而在工作中，很少有同事能写出让吾满意的文档。这说明什么？说明这些文档实在是……不入流，不合格，不规范。吾以前在中兴，专门开过一个“格式优良”的课程，本希望越来越多程序员能学习，结果开过一次。
有程序员就问了，吾写好程序即可，这文档写好了有什么好处？
其实程序跟文档是有类似性的。文档组织不好，程序也很难组织好。
文档是表达汝之思路和内容的。好文档别人看了明白；差文档看了直摇头，有损个人技术威信。
程序是汝之工作产出，文档亦是。
写好文档，是每个管理者、程序高手的必备技能。除非汝只想原地踏步。
掌握好了写文档技能，不仅更美观，也不容易出错。比如项目编号，不会的人手工调整，非常容易出错。
所以，每个程序员必须掌握写文档的技能。
这里需要指出：掌握写文档技能，写出格式优良、规范整齐的文档，是每个人都能够做到的；而内容和组成，则受限于个人水平而定，是难以学习的。
管理感悟：掌握写文档的技能相关推荐
- 跟着吉庆写文档（流程图） の 让“伊妹儿“帮你管理时间
第一版: 由于第一次写文档,只是知道工作所强调的主要内容,但是不知道应该以什么样的形式来表达而已.因此,只是写了一个大概的框架. 吉庆学长: 1)时间管理实际上就是个人管理 2)加载一些图片--图文并 ...
- 从程序员到项目经理（二十九）：怎样写文档
在软件项目中,文档既是一项的重要成果,也是项目管 理的有力工具.通过文档,可以稳定.明确的传达信息,实现项目内的有效沟通.所以写文档对项目经理来说,是一项必备的技能. 然而很多项目经理害怕写文档,似乎 ...
- 如何理解写文档这件事情 ?
目录 目录 前言 对公司而言 标准化流程 最佳实践 对自己而言 前言 个人札记, 写下对 写文档 这件事情的理解, 欢迎讨论. 对公司而言 文档系统是 标准化流程 和 最佳实践 的温床. 我们不仅是在 ...
- python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...
- python代码_如何使用 Sphinx 给 Python 代码写文档
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...
- flowable 中文文档_滴滴实习收获 | 产品经理就是写文档和开会沟通的吗？
本篇文章希望和大家分享我今年的2个思考:一是为什么需要产品经理,二是产品经理的工作核心逻辑是什么.内容会结合<俞军产品方法论>和我自己在滴滴国际化做产品实习的经历. 一.为什么需要产品经理 ...
- 整理项目管理工具，管理笔记，常用文档管理系统
整理一些常见得项目管理工具,相关项目管理者得管理笔记,常用得文档管理系统. 供有需要得人查阅. 1 项目管理工具 1.1 禅道 敏捷的项目管理软件 完整支持敏捷方法Scrum 增加测试.文档.发布.计 ...
- 老油条用什么工具写文档？
写代码,哪个程序员都不害怕. 写文档,哪个程序员都害怕! 为什么? 还不是因为 API 工具不好使,不便捷,同步麻烦,测试看不懂-- 最近调研了身边一些开发团队,发现他们列举的工具中,都出现过同一款工 ...
- 软件开发人员不愿意写文档
软件开发人员不愿意写文档, 我想这主要指的是刚参加工作时间不长的工作人员. 真正的老 鸟是不会这样的.我说说自己的看法,希望大家讨论. 1. 软件开发的大环境不好 软件开发行业在中国的兴起也就是十几年 ...
- 软件开发人员为什么不愿意写文档
2015年第一篇文章,看到这篇文章很多都戳到自己的痛点了,呵呵!转载一下,以示训诫 原文:http://www.51testing.com/html/41/n-197641.html 软件开发人员不愿 ...
最新文章
- (转)Ubuntu12.04上NFS Server安装使用过程
- [密码学] 离散对数比特安全性
- 搭建Git Server － Centos+Gitosis
- 苹果 “Find My” 功能中的漏洞可暴露用户的位置信息
- 阿里巴巴Android开发手册V1.0.0随手笔记
- Cmdbuilding搭建简易流程及问题处理
- c++ opengl 绘制地面_铝合金门窗设计之绘制节点图
- 大数据之spark_spark SQL的建表语句
- matlab 合成t检验,[zz]用MATLAB做T检验（ttest）
- sslcontext java_java – SSLContext初始化
- 安卓开发常用icon/png图样
- Python中except用法和作用
- Python数据全球人口数据
- PIC16F877A与Proteus仿真-ADC
- C语言第13课——文件读写
- crontab -e新增的定时任务没有执行
- uploader.lib php,Fine Uploader文件上传组件应用介绍
- 数字移动通信系统中广泛使用的两大类调制技术
- 银行从业对证书的建议
- sdm660代码编译和刷机