美文网首页IT
关于维护Wiki的简单思考

关于维护Wiki的简单思考

作者: Real_man | 来源:发表于2019-05-20 22:49 被阅读48次

之前公司内部大约有维护130篇wiki,这个数量,其实也不多。

看到当前的项目没有文档,对于我本人来说,平时总是想用文字梳理一些东西,对于写文档也是比较乐意的一件事。以我目前梳理项目的经验,去维护一个项目的文档,暂时想到的有:

  1. 项目设计 类似与简介,能直接对项目有个整体的认识
  2. 数据字典(领域模型) 一般会根据不同功能模块进行划分
  3. 对外提供服务
  4. 依赖外部服务
  5. 流程图 一些业务功能的状态流转图
  6. 项目技术 涉及到的MQ,配置中心,缓存等
  7. 事件单 遇到的Bug,问题记录
  8. 特殊入口 一些不对外暴露,仅对小组内提供的特殊功能

以上能让一个新人快速的熟悉系统,省的每次都要对新人做一次新的解说。我觉得上面的这种结构可以做一些修改,不过目前还没清楚新的结构

项目之外可能会依赖一些会用的,但是却稍微不是那么的经常用到的技术,比如xxx技术再当前项目中的使用。也可以做一些适当的梳理。

闲话

做事情要去降低一些预期,比如外人对自己的预期,自己对将要做的事情的预期。

  • 如果他人对自己的预期太高,就比较难超出对方的期待,如果做出成果可能会被认为理所应当,这个在做事情的时候就要学低调,不能口号响亮,最后什么都没做出来
  • 如果自己对接下来的事情预期太高,就容易三分钟热度,那些由爱生恨的应该就是这样吧。虽然人不能一直都保持理性,但是尽量的要冷静,明白自己想要达成什么样的结果,中间要采取什么样的措施。越贴近实际,空想就越少。预期也不会太高

后面这些闲话,是说给自己接下来再这边的打算,做事,心态放平和,少张扬。

有时候会犯一些错误,不过就是因为犯了错才记得住,才能学聪明。

相关文章

  • 关于维护Wiki的简单思考

    之前公司内部大约有维护130篇wiki,这个数量,其实也不多。 看到当前的项目没有文档,对于我本人来说,平时总是想...

  • 简单使用Wiki

    在团队里中我们经常使用Wiki来工作,使用Wiki非常方便,语法也比较简单 基本常见格式: 1、标题 == 一级标...

  • PHP swoole (3.多进程)

    文档: https://wiki.swoole.com/wiki/search/?q=process 关于进程...

  • 关于“简单”的思考

    今天读到成甲老师的一篇文章,文章前面提到:让自己过得简单。虽然我们缺乏足够的方法和勇气。 简单才能专注,专注才有力...

  • 关于简单的思考

    “简单,指不复杂;头绪少。也指草率;细致、平凡等。还有理解为单纯、不复杂,平凡、一般、普通等等......” ...

  • 浅谈第三方分享自定义页面和参数的一些坑

    起言 关于第三方分享,若只是简单的集成,只需参考http://wiki.mob.com/android-share...

  • 关于CLV的简单思考

    CLV,customer lifetime value,用户生命周期价值。用户与我们的业务、产生关联的过程可以简单...

  • ctf-wiki ARM ROP Codegate2018_Me

    写在前面 ctf-wiki关于arm pwn的arm - ROP[https://ctf-wiki.org/pwn...

  • Material Design

    关于Material Design 的各种详细的介绍,极客学院的wiki写的非常清楚了:http://wiki.j...

  • 蓝牙BLE芯片Ti CC2541 Notify最大吞吐量解析

    关于CC2541吞吐量的最权威测试来自Ti官方的wiki:http://processors.wiki.ti.co...

网友评论

    本文标题:关于维护Wiki的简单思考

    本文链接:https://www.haomeiwen.com/subject/lvhrzqtx.html