• [2013-03-14]使用wiki维护产品文档



    word文档作为产品文档的问题:

    1. word文档本身的设计是为了打印;
    2. word文档的编辑较为繁琐;
    3. 作为产品文档的word文档往往长达百页以上,难以维护,且容易分散注意力,不利于查阅;
    4. 没有一个简单易用的搜索机制;
    5. 文档更新后的发布共享过程比较低效

    Wiki作为产品文档的优势:

    1. wiki的内容是大家都可以编辑的,方便各种信息的聚合;
    2. wiki的内容是修改后直接呈现的,方便共享;
    3. wiki的内容基于Web页面的,各主题独立,查阅时不容易分散精力;
    4. 一般都会有良好的搜索机制(搜索主题或内容,列出相关页面链接);
    5. 可以随时修改,不断演变,基于团队信任方式进行信息共享;
    6. 编辑时没有多余花哨的格式,十分方便;
    7. 以wiki方式组织的产品文档,功能模块以及结构清晰,利于进行文档编撰的分工合作。

    最近团队人员更替,纠结于原先文档的不完备,试着搞搞内网wiki。

  • 相关阅读:
    git 教程
    darknet_ros 踩坑与解决办法
    相机与手臂的校准
    相机的内参外参标定
    VNC windous->linux
    12306 官网硬卧下铺的选择
    /usr/bin/ld: cannot find -lopencv_dep_cudart
    在Windows上安装GPU版Tensorflow
    机器学习基础
    [设计模式]行为型设计模式
  • 原文地址:https://www.cnblogs.com/personball/p/7455817.html
Copyright © 2020-2023  润新知