我们需要一种方式去记录我们所学所知
而这种记录的方式应该尽量摒弃繁杂的格式和样式的困扰我们也需要一种方式去分享我们的经验,每个人的分享,带来的是大家共同的进步
而这种分享的方式应该尽量表达的直观、清晰、简洁我们更需要一种方式来合作,来协同,去完成一些看似很宏伟甚至不可能的事情
而这种合作的方式应该尽量避免冲突、矛盾和繁琐。注重分享才能让我们走的更远、更高。
PolyTechDocs是一个文档协同撰写项目,采用了Jekyll模版,使得可以在忽略字体大小样式,代码格式等方面的情况下进行专注于内容的高效文档撰写。
支持MarkDown、Textile、Liquid、HTML&CSS等多种方式进行文档撰写。同时利用GitHub提供的版本控制模式实现多人协同高效开发。
- 全新的文档合作方式
- 参与性的技术文档分享
- 针对性的经验和学习资源
无论您是产品、设计、研发还是测试人员,都可以利用该平台高效撰写统一格式的文档
- HTML&&CSS: 可以在文档中嵌入任意HTML标签,并利用CSS调整样式,javascript响应事件。
- Markdown标签: 可以利用Markdown标签对段落、字体、格式做统一编写
- Pygments:轻松对任意类型代码进行格式化和关键词上色,让代码具有良好的可读性
- 变量: 可以设置全局变量,对网页、内容、链接地址等各种类型变量进行编辑和处理
- 布局: 可以采用已经提供的模板或者自己编写新的模板,为相同类型的文档提供良好的布局支持
您除了撰写文档外,还可以在任何一个文档模块的下方留言和评论,参与到文档内容本身的讨论中来也是对提高文档质量的一种贡献!
目前正在维护和添加的文档内容有:
计划(但不限于此)增加的内容为:
- Java
- JIRA && TestLink
- Web Service