文档目录结构参考

时间:2022-07-09 05:22:57

一、项目文档

 
开发文档(开发人员使用的文档,5和6部分的文档也适合技术支持人员使用)(借鉴软件开发周期模型方式)

按照项目活动分类:

1. project planning
   overview
   proposal(target and benefits)
   project plan(resource needs)
   legal issues
   QA plan
   投标方案

2. requirements and specification
  user needs
  software requirements specification

3. architecture and design

4. implementation and testing

5. deployment and installation
  release checklist
  release notes

1.6. support
  FAQ/troubleshooting

二、管理文档


1、备忘录(万一在其它文档中找不到有用的信息,这里是最后的希望)

2、会议纪要

3、报告(包括周报、组内通报、跨部门通报、presentations、newsletters等)

4、问题跟踪

5、他人的文档(按人名和角色分类)


三、参考资料

   1 按照科学分类法处理

    如:

    0哲学

    1自然科学

       1.1 计算机科学与技术

              1.1.1 操作系统

              1.1.2 数据结构与算法

              1.1.3 计算机网络

              1.1.4 程序设计语言

                     1.1.4.1 C/C++

                     1.1.4.2 Java

                            1.1.4.2.1 Java基础知识

                            1.1.4.2.2 Java Web框架

    2 社会科学


四、产品文档


1、产品简介
2、产品演示
3、疑问解答
4、技术白皮书
5、评测报告
6、使用手册
7、安装手册
8、维护手册
9、用户报告(包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等)
10、销售培训(包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等)



五 日常文档


1、备忘录

2、学习资料

3、参考资料

4、他人的文档(按人名和角色分类)

5、工作文档

A 日常工作

1、技术委员会
2、培训
3、绩效考评
4、招聘
5、公司文件
6、总结和计划
7、预算和开销

B 技术

1、研究报告
2、提交给他人的文档

C 问题跟踪

六、个人文档


1、思考
2、blog
3、其它杂项

七、软件和工具


比较不错的笔记软件:

寻找最好的笔记软件:三强篇(EverNote、Mybase、Surfulater) (v1.0) :http://blog.sina.com.cn/s/blog_46dac66f01000b57.html