Skip to content

Latest commit

 

History

History
62 lines (32 loc) · 2.14 KB

desc.md

File metadata and controls

62 lines (32 loc) · 2.14 KB

使用帮助说明

每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!

程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。

word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。

它就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。

她可以用来做什么

  • 技术说明文档

    可以用来编写技术文档说明、一些工具说明、常用API及类的说明,也可以编写一些技术规范说明文档以供团队查阅。 例如APP软件下载地址及注意事项说明、手表程序烧录说明、技术文档等

  • 技术分享与沉淀 技术教程、经验沉淀文档等。

  • 创新的想法分享 记录分享自己的对产品的思考与想法。

  • 接口文档 服务器和客户端相关的接口或者类的文档说明。

  • 数据字典

    一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

都有什么功能呢

  • 支持markdown与普通编辑器编写文档

  • 支持本地图片上传

  • 分享与导出PDF

  • 自动保存、离开页面提示保存

有什么问题和需求请及时联系反馈,谢谢 ^^^^

其他注意事项

  • 建设平台的目的:

    1)完成年初部门制定的行动计划中的软件科内部文档平台的目标

    2)实现软件团队资源信息化和信息、技术、项目、文档、资源共享互通。

    3)促进团队间的技术交流、提升与协作。

    4)通过项目实践提升web端的技术能力和积累项目经验

  • 目前由冯德兵、林鑫开发和维护

  • 数据保存在局域网服务器不必担心内部数据外泄