mindpin / docs

团队帮助文档和技术参考

help

团队帮助文档和技术参考

使用 jekyll 构建

发布方法参考：
http://blog.nitrous.io/2013/08/30/using-jekyll-plugins-on-github-pages.html

编辑方法

签出 master 分支后，运行

bundle exec jekyll serve -H 0.0.0.0

增加项目就是在 _repos 目录下增加 md 文件
文件命名规则：

<账号名>-<工程名>.md

增加文件后需要填写文件头部，其中：

• account: github 账号名
• desc: 工程描述（如果原来的描述不详细，这里写详细一点）
• created: 工程创建时间
• updated: 工程最后提交时间
• last-commit: 最后一次 commit 的 id
• type: 工程类型 （项目 project , 库 lib , 演示 demo , 文档汇总 doc）
• alternative: 是否有替代方案
• skills: 开发此工程需要的技能
• threads: 隶属于哪条主线，例如：属于 img4ye 就写 [img4ye]
• design-usage: 最初的设计用途

其他参考资料

http://stackoverflow.com/questions/28100220/jekyll-display-collection-by-category

docs's Issues

2 月 19 日分享

http://weibo.com/p/1001603852651598105317
七牛架构师对于视频类产品和云服务关系的一些分析讲解

中间提到的一些东西，对于我们自己选择IT架构，和说服客户接受我们的IT架构
有很大帮助

---

http://nickcraver.com/blog/2016/02/17/stack-overflow-the-architecture-2016-edition/
stackoverflow 架构

可以留意一下
对于他这样一个网站，各种服务器设备要用到多少台，有一个大致认知就好
以后对于各种客户说明报价和项目规模会有帮助

---

https://help.github.com/articles/adding-a-file-to-a-repository/
github 新功能
现在可以直接上传文件到版本库

---

https://github.com/joebew42/study-path
关于程序员如何提升代码质量的许多学习建议，原则，和参考资料

课题型任务的发布和执行方法

发起者：发出课题

1. 要解决的问题（以团队的技术开发为中心）
2. 用手头容易找到的资料展示一个要达到的核心功能
3. 在课题中需要达到的若干技术指标

执行者：准备开题记录

1. 把要解决的问题详尽的复述出来，写在 github 里
2. 对每个技术指标的理解
3. 以任何方式书面描述你要怎么给团队说明你做出来了

发起者：
核对“开题记录”

执行者：开始执行

后续 1-2 周一次 review

目前的三个课题：
一，指定和检查代码运行结果的沙箱服务
二，使用 react native 实现 android 应用开发
三，根据任意即时通信协议搭建聊天服务

小型静态站（包含中文内容）全文搜索方案研究

方案一：

lunr.js / jekyll-lunr-js-search
https://github.com/slashdotdash/jekyll-lunr-js-search

此方案通过 jekyll 插件，自动给所有文档生成索引文件，保存成一个 json 放置在工程目录下。前端每次执行搜索动作时，都访问这个 json，然后使用 lunr.js 执行搜索动作。

虽然 lunr.js 不支持中文（其实是所有非英语的 UTF-8 字符），但是可以通过简单修改来支持。
但是，这种方案缺点很大，主要有以下几点：

1. 针对中文生成的索引文件太大，当文章较多时，能达到 4-5 MB 的大小。
   事实上 github help 的搜索索引文件就有 5 MB 之大。（看 chrome 的请求可知）
   当带宽不高，或者使用移动网络访问时，性能会很低下。
2. jekyll-lunr-js-search 的索引策略并不科学。它只是弄了一个很呆板的索引 jekyll 的常用主要信息字段的索引方式。而很多小型静态站并没有必要这样索引。

---

方案二：

使用 elastic-search 生成索引，并把索引部署到某个网址作为服务来使用。
这种方式的可行性是有的，工作性能也是很好的。

唯一缺点在于部署和发布起来很繁琐，架构复杂。做起来比较费时间。
我们做小型静态站本身就是为了省时间。用这种方案会本末倒置。

---

方案三：

自己按需编写简单的小型索引方案。
目前正按此尝试。

2 月 24 日分享

http://themeforest.net/category/site-templates/admin-templates
很多收费的后台管理设计方案
点进去，再点 live preview 按钮，就可以看每个方案的具体操作啦

2015 年年终总结填写方法

模板：
从各自邮箱下载 2015年年终工作总结和规划-技术模版.doc 进行填写

---

填写方法：

部门： 互联网研发二部
岗位： 参考以下对照（其实就是根据群里的 教育产品开发定级.xls）

• 技术开发：周建斌，李博超，单祯强，李飞，陈啸峰
• 产品设计：陈湘玉，吴笛
• 内容制作：吴笛，陈湘玉

职位： 开发工程师

工作内容：

• 参与项目名称： 银行科技中心培训平台

• 角色： 项目成员

• 主要使用的工具： 写平时自己用的主要工具即可，写2-3个

• 项目经理： 宋亮

• 提交有效交付物名称：

  • 技术开发：按照自己负责的功能模块，写“xxx开发 - 代码”或“xxx集成 - 代码”。有多条写多条。
    主导/协助那里都写“主导”，如果有参与过其他功能模块修改，则将其列上，并在这一栏写“协助”
  • 产品设计：按照括号里的模块列出（组卷，题库，问答，课程管理，课程导航，教学分组，公告），写“xx模块设计 - 设计稿”。都写“主导”
  • 内容制作：按照括号里的内容列出（柜员培训电子课件制作-流程部分，柜员培训电子课件制作-屏幕关联部分，柜员培训电子课件制作-说明内容部分，WIKI - xxx，WIKI - xxx）。都写“主导”

  完成页数那里不管了。

工作业绩： 按时间顺序写写自己几月做了什么即可（8月前的也可以写。不过只写和这个项目有关的）
新增知识和技能： 根据自己的情况逐条列出。并且说明自己是如何掌握这项技能的，花了多久，对其他人或本项目提供了什么帮助
团队合作及评价： 指和其他团队合作的一些总结，这里吴笛可以写，其他人可略过
思考和建议： 针对产品/项目/团队的：如果有对开发过程和产品的思考建议，写在这里
待完善改进： 针对个人自身的：写个人希望改进/提升的一些工作方法，技能，习惯等

2016年个人规划我就不赘述了，都根据自己情况写吧。
职位定位方面，我发了个表格（教育产品开发定级.xls）到群里，大家可以参考着写

自我价值评估也看着写吧，别太天马行空就好

2 月 23 日分享

https://github.com/santinic/how2
一个有趣的程序，在命令行使用 how2 指令搜索 stackoverflow 网站上的内容以解决问题
实用性且不谈，作为命令行程序这是一个好的范例。