`
tedeyang
  • 浏览: 328269 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

讨论公司技术规范、文档怎么制定。

阅读更多



look look http://www.iteye.com/topic/132181
目前我们公司在代码规范、文档规范、技术规范上还存在欠缺,如上一篇帖子所言,这是我们的机会。呵呵
绝对是一个参与制定这些规范的契机。由我们开发人员制定管理自己的规则,绝对比17大民主多了。

因此,请每个有参与欲望的家伙来发表意见吧,要不然过段时间你就会对着你隔壁提议的某条规范发飙了。嘿嘿

本帖讨论点: 文档规范 ,其他关注点以后再议。
主要问题:
1,【?】文档要不要写?
2,【载体】文档以什么形式为载体最好?(word?txt?bbs?wiki?javadoc?...)怎么共享和管理?
3,【类型】文档要写哪些类型的?(需求文档、设计文档、业务文档、模块文档、代码文档、测试文档、项目管理文档、项目总结文档...)
4,【规格】各种文档都需要写到什么程度,达到什么要求才是合格的?具体而言就是文档的格式怎么规范?内容怎么界定?
5,【检查】要不要定期对文档规范的执行情况进行检查?
6,【执行】最后一个问题是:这大堆文档由谁谁谁来写?

 

【2007-10 bbs】

 

后记:用wiki,而08年公司做了CMMI3,也是一个很好的参考。

分享到:
评论

相关推荐

    蓝牙技术规范文档

    蓝牙技术规范文档是一份详细阐述蓝牙技术底层实现机制的文件,它涵盖了无线技术规范、基带规范、信道控制等核心内容。本知识点详细解释了文档中提到的这些核心部分。 1. 无线技术规范 蓝牙无线技术规范主要包含以下...

    企业信息化技术规范WORD文档.rar

    “企业信息化技术规范.doc”可能详细讨论了以下几个方面: 1. **需求分析**:企业在信息化前需要进行深入的需求调研,明确业务流程、数据处理需求、系统功能期望等,以便定制符合企业特色的解决方案。 2. **系统...

    Web前端开发规范文档(css/javascript)

     本规范文档一经确认, 前端开发人员必 须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性...

    GPON 984.2 技术规范文档

    根据文档内容,技术规范主要涉及以下几个方面: 1. **传输系统和媒体,数字系统和网络**:这部分描述了数字传输系统和数字线路系统,以及它们在本地和接入网络中的应用。G.984.2标准特别针对的是使用光纤作为传输...

    测试管理规范文档

    ### 测试管理规范文档知识点详解 #### 一、编写目的 本文档旨在为测试团队提供一套标准化的工作流程和规范,确保软件开发过程中测试活动的有效性和高效性。文档着重于: - **实施与控制**:规范测试流程,确保...

    软件设计的编程规范和技术文档

    【软件设计的编程规范和技术文档】讨论的是在软件开发过程中,如何遵循良好的编程规范和技术文档编写,以确保软件的质量和可维护性。其中涉及到的主要知识点是Linux系统中的I/O编程,特别是与文件操作相关的系统调用...

    Python-中文技术文档的写作规范

    本主题聚焦于“Python-中文技术文档的写作规范”,旨在为Python开发者提供一套适用于中文环境的文档编写准则,确保文档的质量和可读性。下面我们将详细探讨这一规范的各个方面。 首先,文档的结构应当清晰、逻辑性...

    Java EE6 规范文档

    Java EE6 规范文档是Java企业级应用开发的重要参考,它不仅定义了最新的技术规范,还提供了详细的实现指导,帮助开发者构建高效、稳定和可扩展的企业级应用。通过采用Java EE6,开发者可以利用其丰富的特性和工具,...

    网络工程技术文档编写规范

    - 当文档面向内部使用时,可以更加直接和深入地讨论技术细节;而面向客户时,则需要更加注重展示解决方案的价值和易于理解的语言。 #### 7. 搜集信息示例 - 在编写文档过程中,可能需要各种支持信息,如设备规格、...

    JDBC 4.3规范文档

    规范文档还包含了更多技术性的描述,关于JDBC驱动、连接数据库、执行SQL语句、事务管理、元数据处理和资源管理等核心概念和技术的详细说明。 在学习JDBC的过程中,了解其规范是至关重要的。它不仅提供了接口的定义...

    天蝎2.0 整机柜服务器技术规范

    天蝎2.0 整机柜服务器技术规范,说明:本文档是天蝎2.0 技术规范的讨论稿,仅供参考和听取意见反馈,不作为天蝎2.0 整机柜服务器技术规范正式发布版本) 天蝎2.0 整机柜服务器解决方案, 是在天蝎1.0 技术规范基础上的...

    java开发规范文档

    Java开发规范文档是指导初级开发者遵循的一套标准,旨在提升代码质量和可维护性。文档的目的是确保开发人员能够以统一、规范的方式进行设计和编码,从而增强代码的可靠性、可读性、可修改性、可维护性和一致性。下面...

    软件工程项目开发文档规范(国标)

    2. 更新:随着技术发展和项目经验积累,适时更新文档规范,使之与时俱进。 通过遵循《软件工程项目开发文档规范(国标)》,可以提高软件开发的标准化水平,降低项目风险,提升团队的协同效率,从而打造出高质量的...

    asp设计文档规范asp设计文档规范asp设计文档规范asp设计文档规范

    在进行ASP项目开发时,设计文档规范是至关重要的,它确保了项目的可维护性、团队间的协作效率以及代码的一致性。下面将详细探讨ASP设计文档规范的关键内容。 一、项目概述 在设计文档的开头,应包含项目概述,明确...

    document-style-guide, 中文技术文档的写作规范.zip

    《中文技术文档的写作规范》是一份开源的指导性文档,旨在帮助中文技术作者和开发者遵循统一、清晰、准确的写作风格,提高技术文档的质量和可读性。这一规范涵盖了多个方面,包括文档结构、语言表达、排版格式、术语...

    Bluetooth 蓝牙系统技术规范

    最后,蓝牙技术规范文档的免责声明和版权信息(Disclaimer and Copyright Notice)申明了该文档按“现状”提供,没有提供任何形式的保证,包括但不限于对适用性、非侵权、特定用途的适用性或任何由于提案、规格或...

    大公司软件工程文档文档

    6. **代码规范文档**(Coding Standards):规定了代码编写的一致性和可读性标准,包括命名规则、注释规范、编程风格等,有助于代码审查和维护。 7. **测试计划**(Test Plan):详细列出测试策略、测试用例、预期...

    简单技术文档范本.rar

    下面将详细讨论技术文档的重要性和内容结构,以及如何利用这样的模板来编写有效的技术文档。 1. **技术文档的重要性**: - **沟通桥梁**:技术文档是开发团队与非技术人员(如项目经理、客户)之间沟通的桥梁,...

    JTS官方技术规范中文翻译版

    这个中文翻译版的技术规范详细介绍了JTS的核心功能、设计目标以及执行策略,帮助开发者理解和应用该库。 1. **总论**:这部分通常会概述JTS的主要功能和目标,解释其在地理信息系统(GIS)中的作用,以及如何增强...

    卫生信息共享文档编制规范.pdf

    首先,文件提到了多个中国国家标准(GB/T)编号,如GB/T 2659-2000、GB/T 2260-2007等,这些编号代表了中国的国家标准,涵盖了各行各业的技术规范和标准。例如,GB/T 2659可能涉及地区分类代码,GB/T 2260可能涉及...

Global site tag (gtag.js) - Google Analytics