Contents
×
给力知识库使用指南
  •  
    1 概述
  •  
    2 系统的使用
    •  
      2.1 读者指南
    •  
      2.2 作者指南
      •  
        2.2.1 Markdown语法简介
      •  
        2.2.2 文档存盘
      •  
        2.2.3 查找、反查及定位
      •  
        2.2.4 插入图片
      •  
        2.2.5 分享文档
    •  
      2.3 联合编辑(`暂未实现`)
  •  
    3 Todo list

给力知识库使用指南

Keywords: 知识库,Markdown,写作,指南
Original published url: http://www.geiliedu.com/manual/1
Shared: Visits: 755 Created at: 2015.11.25 Updated at: 2015.11.25 Author: geiliedu(282055808@qq.com)

1 概述

给力知识库也即geiliedu.com推出的第一个版块。

知识库对个人以及一个组织的重要性是显而易见的:有助于个人及组织的技能和知识系统化、网络化,积累知识和技能的过程中找短板。在降低新员工培训成本,提高员工之间的沟通效率上,意义重大。

给力知识库以Markdown的方式组织内容,以文章的管理单位,本文中文档与文章是同一个概念。

登录用户可在线撰写自己的文档,可小范围分享、公司范围分享,浏览公司范围分享的文档和小范围分享给自己的文档。未登录用户只能浏览公司范围分享的文档。文档写作遵循日渐流行的Markdown格式,Markdown易学易懂,表现能力满足绝大多数应用场合。

2 系统的使用

2.1 读者指南

  • 文档列表:未登录用户打开网站,首页会显示最新的公司范围共享的文档列表。登录用户打开网站,首页会显示最新的公司范围共享的文档、自己的文档和小范围分享给自己的文档列表。
  • 文章列表分类:点击Articles菜单对应的AllMyselfSharedPublic,将分别显示所有有权阅读的文档自己创建的文档小范围共享的文档 以及公共文档,可在文档列表中任意点击选择一篇阅读。
  • 打开上一次阅读的文章:点击Content菜单,将打开上一次阅读的文章。
  • 阅读页面可作如下操作
  • 点右侧工具条的Switch to edit mode可切换到编辑页面,并定位至当前章节。非作者只读,目的是参照文档的Markdown书写格式,作者可修改编辑。
  • 登录用户可点击工具条的Category this article按钮,将感兴趣的文章按自己的分类习惯归类,以便日后更容易找到。(暂未实现
  • 可根据需要点击Print按钮打印文档。(现在的打印不支持图片,待改进...)
  • 左边是文档的目录,树形结构。目录树可折叠或展开,点击根节点(文档标题)可全部折叠或展开。点击非根节点时,可定位到文档中对应章节标题。
  • 对于登录用户,可随时点击Create a new article创建新文档。此操作和当前浏览文档无关。
  • 编辑页面可作如下操作
  • 点击Save and switch to view mode按钮可切换回浏览页面,并定位至光标所在章节。
  • 对于登录用户,可随时点击Create a new article创建新文档。此操作和当前编辑文档无关。
  • 左侧目录树的导航及过滤:点击左侧目录树的章节,会定位到正文的对应章节。过滤是只显示包含过滤词的目录(过滤功能暂未实现)。

2.2 作者指南

登录用户都可以写文档,成为作者。登录用户可使用读者指南章节列出的所有操作,本章节不再重复介绍,除此之外,还可以创建新文档、编辑之前自己写的文档。

2.2.1 Markdown语法简介

  • 语法参考,点击这里,以及这里
  • 初期使用者,直接在本站中找一篇格式丰富一点的文档,切换到编辑模式,拷贝粘贴到自己的文档里面,慢慢改即可。
  • 空格、空行很重要:例如以-或者*开头的列表-或者*字符后面必须要有一个空格。>开头的区块也需要在>后面跟空格。然后列表区块结束后,需要一行空行,否则会出现误排版。

2.2.2 文档存盘

标题关键字或者正文有一处地方修改过时,会发现右侧工具条中的切换浏览模式存盘按钮变成彩色,说明需要存盘。点击切换浏览模式按钮会先存盘,然后切换到浏览模式。点击存盘按钮将保存文档,按钮都变回灰色。其中也可以用Ctrl+s组合键完成存盘。

2.2.3 查找、反查及定位

从浏览模式切换到编辑模式并定位到相关的位置,称为查找(现在的系统版本只有在Chrome浏览器中查找的定位才准确)。而从编辑模式切换到浏览模式时将光标所在章节置顶的过程称为反查。 - 目录树自动生成:文档存盘是,会自动搜索正文的章节生成文档目录,自动编号,并在左侧渲染目录树用于导航。 - 点击目录树导航:在文档浏览模式,点击目录树可定位到对应章节,章节标题置顶。在编辑模式中,点击目录树的定位,目前的版本只有Chrome比较准确。所以推荐使用Chrome浏览器编辑文档。

2.2.4 插入图片

本站设计了一个图片选择器,图片按月归类管理。右上角有两个按钮,一个上传图片,一个关闭图片选择器。最新上传的图片放在最前面。点击图片后,会在顶部生成该图片的代码并选中,作者可按Ctrl+c拷贝,然后在文档中相应位置Ctrl+v插入图片代码。 pic 推荐的画图工具:软件项目相关的图片,包括系统构架图、流程图、时序图、状态机图等,推荐使用UMLet

2.2.5 分享文档

作者所属文档的浏览模式中,右侧工具条有个Share按钮,点击后弹出文档分享管理器,如下图所示: pic - 其中Public是全局分享,所有打开本站的人均可浏览。 - 分享管理器的左侧是用户组,点击后显示本组的成员。(暂未实现) - 勾选要分享的对象,然后点击右上角的存盘按钮即完成分享。

2.3 联合编辑(暂未实现

作者及小范围分享的成员均可编辑对应文档,只能同时有一个人编辑,编辑时文档处于加锁状态,切换到非编辑模式后自动解锁。其他人可以看到谁正在编辑文档。

3 Todo list

类型 描述 提出日期 优先级 完成情况(日期)
文章分类及列表 按All、Myself、Shared、Public分类文档列表 2015.11.10 2015.11.18完成
自建二级分类 在三个系统分类的基础上自建分类,以便快速查找 2015.11.10
按标题搜索 按标题搜索查找文档 2015.11.10
按关键字搜索 按关键字搜索查找文档 2015.11.10
全文搜索 在正文中搜索包含过滤词的文档 2015.11.10
目录树过滤 目录树中只显示包含过滤词的目录 2015.11.10
个性设置 用户可以设置浏览时是否显示章节号 2015.11.10 现在是都显示
图片按月归类 点击不同的年月,归类显示当前月的图片 2015.11.10 现在点击无反应
用户分组 设定管理员账号,管理用户组及组成员 2015.11.10 现在是一个大组
打印 打印不了图片,克隆全屏页面,使用浏览器自带打印功能 2015.11.10
最近浏览文件 菜单中的Recent功能,也即最近打开的文件 2015.11.10
书签功能 菜单中的Bookmarks功能,读者可收藏和管理书签 2015.11.10
visits 统计visits数量 2015.11.10 2015.11.18完成
更新指南 Todo list有完成的任务时,更新本指南的相关说明 2015.11.10