`
yangyi
  • 浏览: 115692 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

关于文档

 
阅读更多
文档应该包括两大部分，一部分是清晰的代码结构和注释，比如Concurrent API就是这样，还有一部分是文字文档，包括三个小部分：一是开发文档，应该讲架构和功能；二是索引文档，详细介绍功能和参数，三是用户文档，包括安装和使用说明

文档最困难的莫过于版本的一致性，当软件升级后，一些obsolete的内容和新的feature很难同步。要是架构发生了变化，那就更困难了。一般document team都不是太精于技术，所以也会产生一些问题。

只能说任何事物永远都有改进的空间，但是同样也永远没有达到完美的程度
分享到：
| NIO Web服务器示例
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    用友U8中文帮助文档

    用有U8中文帮助文档：用友帮助文档\AP_zh-CN.chm 用友帮助文档\AR_zh-CN.chm 用友帮助文档\AU_zh-CN.chm 用友帮助文档\BO_zh-CN.chm 用友帮助文档\CA_zh-CN.chm 用友帮助文档\CG_zh-CN.chm 用友帮助文档\CM_zh-...

    关于文档管理系统的一些资料

    6. **文档管理系统毕业设计范例.doc**：这可能是一个关于如何设计和实现文档管理系统的项目报告，包含理论背景、需求分析、系统架构、技术选型等信息，对于学生和初学者来说，这是一个很好的参考资源。 7. **Hydms_...

    domino xpages 文档开发 文档的状态

    总之，掌握Domino XPages中关于文档状态的判断和处理是构建高效、用户友好的应用程序的关键。通过熟练运用`currentDocument` 和其他相关的对象及方法，开发者能够灵活地控制用户的操作体验，保证数据的准确性和一致...

    HIKVISION开发文档2.0

    任何关于文档内容的复制和使用，以及将信息传递给第三方，都需要得到海康威视的事先书面同意。 文档还提到了对文档内容的修改权，海康威视保留了根据实际情况进行产品变更的权利，而无需事先通知。这体现了在快速...

    DB2 V10学习文档

    关于文档的版权声明部分，它告知用户，虽然文档中的信息尽可能地被核实过，以确保完整性和准确性，但IBM并不提供任何明示或暗示的保证，文档以及其中包含的信息是“按原样”提供的。文档还强调，所提供的信息基于IBM...

    开发文档---包含各种项目文档

    - **文件给制实施规定**：可能是关于文档制作的标准或流程，指导如何编写和组织开发文档。 - **详细设计说明书**：详细描述软件系统的架构、模块、接口和实现细节。 - **操作手册**：类似于用户手册，但更专注于...

    springboot官方文档

    首先是关于文档的介绍，包含了文档的用途和目的，以及如何获取帮助。接着是入门指南，帮助开发者快速上手SpringBoot，包括安装指导、创建第一个SpringBoot应用、以及如何使用SpringBoot CLI快速开始。 在安装...

    微软Moss文档管理解决方案

    9. **报告和分析**：可以生成关于文档使用情况的报告，帮助管理层了解文档管理系统的效率。 10. **内容发布**：支持内容发布到内部或外部网站，便于知识分享和信息传播。 压缩包内的文件提供了有关微软文档管理...

    豆丁文档免费下载

    10. **社区交流**：加入相关的在线社区或论坛，如技术交流群、学习小组等，可以获取更多关于文档分享和下载的实用技巧，以及最新的资源信息。 了解并掌握这些知识点，用户就能更高效、安全地利用豆丁文档免费下载...

    Android代码-Glide v4最全中文文档来了！

    关于文档的一致性 本文档将定期与官方文档做同步校对工作，参见 翻译文档同步计划 。 如果您在阅读过程中发现有错漏或不同步的情况，欢迎直接发起 Issue，也可以协助我们改进翻译。 免责声明 本仓库并非官方维护，...

    mysql5.6官方文档

    接下来，文档提供了关于文档使用的信息，比如排版和语法约定，以及对于不同发行版可能不包含的特性进行了说明。文档还提供了关于报告BUG或问题的指导，以及关于MySQL标准合规性的章节，包括MySQL对标准SQL的扩展和...

    西北工业大学软件学院软件文档写作作业（全）

    此外，提供的“文档写作”文件可能包含更多关于文档格式、写作规范、常用模板等方面的资料，帮助学生形成良好的文档编写习惯，了解标准化的文档结构和语言表达。 总的来说，这份资源集是软件工程学习者的宝贵财富，...

    关于文档管理软件的解决方案（1）

    文档的管理是一个迫切有待解决的问题，近年来有些软件从业人员已经考虑到这方面的问题，针对这一问题想入手开发出关于文档管理的软件。那么这样的软件应该怎样开发，要解决哪些问题呢？现把其大致的基本功能要求描述...

    BLE nRF52832官方文档

    2. 文档结构概览，涉及修订历史、关于文档、外围命名和缩写、寄存器表、寄存器等部分。 3. 芯片特性，如外围设备的命名、引脚分配（以QFN48引脚为例）、绝对最大额定值、推荐的操作条件、CPU特性（包括浮点中断、...

    微软复合文档文件格式 中文

    - **复合文档头部**: 包含了关于文档的元数据，如版本信息、创建日期等。 - **内容**: 头部通常还包括指向文档中各个部分（如数据流和存储）的指针。 ##### 4.2 字节顺序 复合文档文件格式规定了数据在内存中的字节...

    文档网狐文档网狐文档网狐文档

    这个标题看似重复，但我们可以从中推测这可能是一个关于“网狐”平台或者与之相关的文档集合。网狐可能是一个在线文档分享平台，或者是某个特定软件或项目的名称。文档通常包含了各种信息，如使用指南、技术规格、...

    PDM系统WindChill使用文档英文版

    这提供了关于文档发布日期和版本号的背景信息。 2. 版权声明：文档说明了所有内容均受到版权法的保护，包括美国及其他国家。文档提供给了许可软件用户制作文档印刷副本的权利，但仅限于内部/个人使用，并需遵循相应...

    NTP RFC文档

    最后，RFC 5905文档提到了关于文档当前状态、任何勘误以及如何提供反馈的途径，确保了该文档的开放性和持续更新。文档的这些特性确保了它不仅是NTPv4协议的权威描述，也是一个对整个互联网社区开放的、可以持续发展...

Magicbox
Global site tag (gtag.js) - Google Analytics