惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

PCI Perspectives
PCI Perspectives
Threat Intelligence Blog | Flashpoint
Threat Intelligence Blog | Flashpoint
C
CXSECURITY Database RSS Feed - CXSecurity.com
P
Palo Alto Networks Blog
S
Schneier on Security
Scott Helme
Scott Helme
T
Threat Research - Cisco Blogs
K
Kaspersky official blog
Microsoft Azure Blog
Microsoft Azure Blog
T
The Exploit Database - CXSecurity.com
C
Cybersecurity and Infrastructure Security Agency CISA
T
Tenable Blog
G
GRAHAM CLULEY
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
Cyber Security Advisories - MS-ISAC
Cyber Security Advisories - MS-ISAC
I
Intezer
D
Docker
月光博客
月光博客
L
Lohrmann on Cybersecurity
Latest news
Latest news
B
Blog
罗磊的独立博客
M
MIT News - Artificial intelligence
S
Securelist
Know Your Adversary
Know Your Adversary
Help Net Security
Help Net Security
Recorded Future
Recorded Future
S
SegmentFault 最新的问题
N
Netflix TechBlog - Medium
T
Threatpost
H
Hacker News: Front Page
K
KPMG report finds enterprise disconnect between AI and its ROI | CIO
人人都是产品经理
人人都是产品经理
F
Fortinet All Blogs
博客园 - Franky
P
Proofpoint News Feed
大猫的无限游戏
大猫的无限游戏
Blog — PlanetScale
Blog — PlanetScale
有赞技术团队
有赞技术团队
博客园 - 【当耐特】
A
About on SuperTechFans
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
T
Tor Project blog
Google Online Security Blog
Google Online Security Blog
Application and Cybersecurity Blog
Application and Cybersecurity Blog
cs.AI updates on arXiv.org
cs.AI updates on arXiv.org
Engineering at Meta
Engineering at Meta
Webroot Blog
Webroot Blog
Security Archives - TechRepublic
Security Archives - TechRepublic
Microsoft Security Blog
Microsoft Security Blog

博客园 - yankchina

[C++]VisualC++2010Express英文版试用手记 [C++]C++学习的一些建议 [Soft]物联网时代中的编程语言 - yankchina - 博客园 [Web]Web在线地图API试用笔记 [Python]命令行解析器Argparse的试用手册 [PHP]PHP技术基础 [Blog]将syntaxhighlight与LatexMathML本地化 [Soft]软件技术的两个趋势 [Soft]RAD的代价 [Python]快速解析数据库视图XML配置获取数据库字段说明 用VBA批量输出Outlook通讯录内容 - yankchina - 博客园 试用交互原型设计软件Axure RP Pro 4 云计算零接触 Camtasia Studio 7 试用笔记 命令行调用Lame批量压缩MP3 [C++]千万不要碰VisualStudio - yankchina - 博客园 CSS 使用经验备忘 用Compare It! 4 比较Word Wiki 比较
文档整理经验谈
yankchina · 2010-04-19 · via 博客园 - yankchina

前言

缘起

目前我正在做一个多人项目,其中文档管理由一个新人来担当。领导让我给这个新人进行相关指导。文档管理一直是我所最重视的环节,在一个技术项目开发过程中,文档就是生命线。如果离开文档,技术开发就完全没有基础。正好借着这个机会,我将这些年的一些经验与教训进行总结,不仅为了这个新人,也为了我,做一个较为完整的文档管理方案。

目的

  1. 多人协作的文档管理。虽然是单个人管理,但其中许多内容都是多人进行协作完成的;
  2. 完备时间回溯:文档其实就是智力产品的物质记录。有效的文档管理可以实现时间回溯,能充分再现过往某个时间点上的群体思维状态;
  3. 有效沟通:文档也是一种沟通工具。良好的文档管理为多人间的信息沟通提供保证,让小组中每个人能跨越时空进行信息沟通。

原则

  • 简单至上:我相信“一切繁缛的管理都是无效管理”。追求管理的简单高效是每个项目组所有产品的共同目标,文档管理也不例外。因此,从管理方案到管理工具,力求简单实效,不“唯工具论”,不盲目追求所谓的“工作法”,尽量不添设电子产品;
  • 原始档与整理档分离:原始档是最初提交的文档。只要有提交与修改,就是一个独立的原始文档,绝对不能进行覆盖操作。原始档可能只是工序流程中的一个阶段性产品,其不一定具有有效性。整理档是经过合并、修改、排序与整理的文档,这些文档应该是有效的;这两类文档一定要分开管理。所有整理档都是由原始档整理而来,并且在原始档中有同样的备份;
  • 进出文档要记录:在一个多人协作环境中,文档总是从某个人处得到,再流到另一个人处去。如果不采用制度化的方式来进行文档进出管理,则一定会出现问题,无法重现文档流转的过程。常常是因为文档流转的问题,导致过期文档流向错位,造成许多工作丢失;

习惯性清理:在文档管理中,最需要的就是习惯性的清理工作。这很像是在进行家庭内务打扫一样。习惯性地随手做做文档清理,能有效地提高工作效率。而且清理工作要分层次分步骤进行,平时进行小范围整理,到了一定阶段时要进行总体整理,并进行刻盘备份操作;

    技术方案

    工具

    在Windows系统中管理文档,不如Linux系统一样方便。因为Windows系统操作员往往太依赖于图形界面,不擅于用脚本语言进行管理,所以在Windows上更依赖工具软件。下面是我在Windows平台下常用的一些文档管理软件。

    1. TotalCmd:一款双窗口的资源管理器。使用TotalCmd可以很方便地进行文档复制与更名操作,而且与Python等脚本语句结合,可以方便地进行诸如“日期命名文件夹”等操作;目前版本为 7.2。
    2. Python:一个非常好的脚本语言\footnote{新手不建议学习,Python的语言结构比较特殊}。在Windows下我一般选择ActivePython 2.6 版本。
    3. Google Calendar:一个非常好的Web日历管理软件。一般可以用它来记录文档进出记录。我一般是采用 VIM + Calendar 插件,然后通过 Google Calendar API 将进出记录同步到 Google Calendar 上

    原始档整理

    原始档主要为了备份。我采用三层目录结构:即“日期目录”->“进出目录”->“项目目录”

    • 主目录以日期排序:在原始档存放的主文件目录下,应该以日期进行排序。将每日的原始文档都放在同一个日期目录下,非常有利于日后的检索与备份操作。
    • 在日期目录下,应该以“进出”进行目录命名。我的分类方法是采用"To_"和"From_"+人名拼音方式来区分进出文档的。例如 "To_WangEr"表明该目录中的文件是当日给王二的;"From_ZhaoWu"表明该目录中的文件是给赵五的。采用拼音而非中文的好处在于,有些文件搜索工具对于中文排序不是很好,如果采用拼音可以很好的进行排序,从而提高检索效率;
    • “进出”目录中再根据每个项目创建目录,其中存放原始文档。如果某日多次提交同名文档,则对该文档后增加数字后缀,如"_1","_2"等

    整理档

    整理档主要为了项目组内信息交流。我采用两层目录结构:即“项目目录”->“进度标识目录”

    • 主目录以项目英文名命名:每一个项目都应该有一个英文字母的命名,这个项目的整理文档都放在该目录下;
    • 进度标识目录用于区别不同状态的文档:一般来说,一个项目组的文档有如下几种状态:
      • 草拟(Draft):刚刚起草,没有经过集体智慧讨论验证的;
      • 最新(Head):已经讨论,但还会根据项目实际情况逐步更新;一般文档都是这样的;
      • 参考(Reference):已经成文的文档,作为项目开发中的参考文献,如项目中的文档模板、中英文对照表、项目组成员联系方式表、会议记录等;
      要从原始文档中挑选出必需的文档,将其放在不同状态的目录中。这样本组人员就可以在统一的目录中访问到最准确的文档;

    军规

    做任何事都要有规范。经过多年的实践,我的规范如下:

    • 清扫在于制度化:我一般每天都进行两次文档清理工作,一次在午餐前,一次在下班前。其中午餐前的一次主要是将一些邮件附件/QQ文档等进行归档,下班前我会花30分钟时间整理今日的文档,挑选一些文档进入“整理档”中;
    • 每旬刻盘备份:现在刻录成本很低,我一般每10天刻盘进行文档备份;
    • 多人监督:我发现在一个封闭的环境下,单独操作往往无法很好的完成工作。如果是一个多人协作组中的文档管理,应该由专人负责,并且组内所有人进行监督。监督方法很多,比如例会上的检查,比较各自文档是否统一最新;项目负责人进行“飞行抽查”文档管理情况等;
    • 逐步改进:文档管理是一个长期的过程。不要期望一次性就能完成。要养成逐步改进的工作作风,不断地探索新的管理方法;