b528in / prdsnippet

收集需求文档中的控件片段，做成snippet在sublime text中复用。让文档易读，内容不遗漏。

PRD Snippet

使用文档

new snippets

• stepper:步进器 可以设置步长，上限，下限，是否支持输入框输入
• badgen:badge notification 表示无数字的徽标
• badgem:badge messages 表示有数字的徽标，可设置最大的消息数目
• radio：单选按钮，可设置选项名称、选项值、选项状态

---

简介

产品经理在写作需求文档过程中，会用到通用的控件描述，而且控件复杂起来还容易遗漏规则。所以本项目的目的就是：

• 收集常见的产品需求文档写作片段，加以复用
• 在写作过程中根据提示核查，防止规则遗漏
• 让文档看起来美美哒，这离不开Markdown

借助sublime text 3中的snippet功能，最终实现像写代码一样，通过关键词输入，提示控件内容，然后补全参数即可。

gif

我怎么使用呢？

当前可以手动安装，等snippet积累到一定的数量，我会提交到 package control中。

1. git clone 或者下载项目
2. 在sublime中找到 Browser Packages
3. 把项目放到Packages文件夹中即可

我可以根据我的文档写作习惯修改吗？

Certainly,do whatever you want to do!

“你写的不准确，应该这样写...”

是的，不同的业务需求不同，可能会很常见。

1. 希望做到尽可能通用。
2. 对于的确有错误的地方，欢迎在Issues中提出来，我会尽快修改。

找组织

如果你是用其它高效的方式同开发交流产品需求文档，也欢迎你加入我们。同开发人员高效的沟通，是我们的根本目的。

1. 讨论帖可以来这里：V2EX
2. 想聊一聊可以来这里：Telegram

如果你想参与进来，非常欢迎：

1. Fork it!
2. 创建你的特性分支: git checkout -b my-new-feature
3. 提交commit: git commit -m 'Add some feature'
4. push: git push origin my-new-feature
5. Submit a pull request

---

参考及感谢：

• 这个控件叫什么
• 什么是Markdown？
• 超棒的编辑器 sublime text 3
• 关于sublime text 3 snippet参见官方文档
• Git教程参见Git教程
• docute

prdsnippet's Issues

下一步会用docute做一个文档，包括控件的简要介绍，方便查找浏览。

现在snippet比较少，所以暂时委屈一下。