Skip to content
/ pg Public

研发团队的工程效率实践-《如何通过Gitlab+七牛云存储来构建在线产品需求文档》

License

Notifications You must be signed in to change notification settings

yangwenmai/pg

Repository files navigation

pg

Build Status Go Report Card Documentation Coverage Status GitHub issues license Release star this repo fork this repo

Stargazers over time

Stargazers over time

一步一步教你搭建属于你或你们团队的在线文档。

研发团队的工程效率的实践。

关键词:Axure, Gitlab, Github, 七牛, fasthttp.

目标

  1. 快速将 HTML 页面生成一个可预览的在线地址;
  2. HTML 页面也能够被版本管理系统管理起来(Gitlab, Github, Coding, 码云等);
  • 每一次改动都有迹可循,别以为你偷偷改产品文档我们就不知道了。
  1. 能够及时同步新增和变更需求;

典型的应用场景

产品经理的在线文档,简单的流程如下:

  • 产品经理撰写需求文档
  • 提交到 gitlab
  • 触发 Gitlab Webhook
  • 触发 pg 的处理接口(拉取项目需求文档到服务器-使用 qshell 上传需求文档到 qiniu bucket)
  • 通过钉钉机器人通知相关群组。

其他更多的应用场景

最新公告,用户帮助,升级说明等。

对于日常的产品需求文档变更,只需要做一件事情:

  • 需求文档修改完成之后,Push 到 gitlab 即可。

安装

go build

运行

./pg -base_url "http://xxxxx.bkt.clouddn.com/" -qiniu_bucket "my-pg" -access_key "xxxxxx" -secret_key "xxxxxx" -qshell_path "/Users/yourname/xxx_tools/qshell-v2.1.7/qshell" -json_path "/Users/yourname/xxx_data/pg-test/json" -prd_path "/Users/yourname/xxx_data/pg-test/prd"

参考资料

  1. 一键生成 Github Go 项目 - gpt
  2. 针对本项目的详细阐述博文

About

研发团队的工程效率实践-《如何通过Gitlab+七牛云存储来构建在线产品需求文档》

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published