sward安装及入门指南

​项目管理工具帮助团队更高效地进行项目管理，能让你轻松规划、高效分配任务、实时跟踪进度、团队协作无缝衔接，让每个项目都高效完成。

目前常用的项目管理工具有JIRA。我今天推荐一款国产的开源免费、简洁易用的项目管理工具——Kanass。我们先通过以下的功能介绍和优势介绍来初步了解一下Kanass。

Kanass的主要功能有项目管理、事项管理、项目集管理、工时管理、统计分析等。

Kanass支持两种项目模型，每个项目还拥有独立的成员权限管理，事项类型、表单与流程设置。

Kanass支持敏捷式开发与传统的瀑布式开发两种模型

每个项目内置需求、任务、缺陷三种基本的事项类型，还可以扩展自定义的事项类型

项目内包含迭代、计划、版本、里程碑等模块功能，还集成了sward知识库和TestHubo接口测试，便于使用文档和直接测试

项目内有事项统计、工时统计功能

每个项目拥有独立的成员与权限管理模块，只用于当前项目；

事项有需求、任务、缺陷三种基本事项类型，列表，详情，甘特图，看板4种视图，还可自定义属性与流程规则

初始化需求、任务、缺陷三种基本类型，也支持自定义类型，定制专属的流程与表单；

支持列表，详情，甘特图，看板等多种视图查看；

支持自定义事项属性与状态流转

事项中的属性与状态流转也可以根据需要来自行设计；

项目集中统一管理项目的项目，在更到的层级查看统计，也有用独立的成员与权限。

对一组相互关联的项目进行统一协调和管理的过程；

以项目集为单位，用不同维度统计事项，工时，在项目集分配权限，以便高效、安全的推进多个项目；

作用与当前项目集的成员与权限

记录工时，统一查看工时并且提供工时统计功能。

可在列表中查看所有事项成员的工时，也可只查看我的工时列表

提供工时统计功能，可根据项目、成员、事项多种组合来查看工时

支持事项统计，工时统计，还有可自由组合的仪表盘功能。

含有以工时、事项等为基础的统计

以图表形式展示事项发展趋势，或以各种属性统计事项数据；根据项目，成员，事项多种组合，按照日期统计工时；

提供以项目、项目集为单位统计事项的各种报表，用户可使用这些自由组合设计仪表盘；

Kanass 支持多种项目模型，拥有强大的事项跟踪与管理功能，还有丰富的统计功能；同时做到页面简洁，上手容易，安装简单。使用备份、日志审计、权限保证数据安全。而且支持多版本多终端，集成开放，免费开源。

支持瀑布式开发与敏捷式开发两种模型，提供三种基本事项类型，还可自定义扩展；跟踪事项状态、记录工时，还可设置事项之间的各种关联，便于协调。

支持敏捷式模型与瀑布式开发两种项目模型；

提供需求、任务、缺陷等多种事项类型，还可以自定义事项类型，根据不同的事项类型定制不同的流程规则与表单属性。

提供列表视图、详情视图、看板视图和甘特图视图；

支持各种维度的事项统计，工时统计，还有可自己设计的仪表盘功能。

提供以事项、工时为单位的统计

从不同的维度统计分析事项，便于管理者充分了解项目的进程

提供不同维度的事项统计报表，用户可使用这些自由组合设计仪表盘；

可自定义事项类型、表单、流程、权限、仪表盘等。

除了内置的三种基本数据类型，还可以添加自定义事项类型

自定义流程，用于事项的状态流转

 Kanass探索:一款开源免费、简洁易用的项目管理工具

知识库管理软件是一种用于创建、组织、存储、维护和提供访问知识库的软件系统。常用的知识库软件有confluence，我今天推荐一款国内开源免费、简洁易用的知识库管理工具 - sward。我们先通过以下的功能介绍和优势介绍来初步了解一下sward。

sward的主要功能有知识库管理、文档管理等。

知识库能集中存储、组织和管理特定领域的知识，拥有独立的成员与权限，保证数据安全。

每个知识库可以看做一个独立的项目或团队工作区，里面有目录和文档，方便查找和管理。知识库可以根据项目、团队或部门进行划分，方便管理和查找。

知识库内部的目录用树形结构展示，明确上下级关系便于管理与查找；目录之间下级文档和下级目录可以相互移动，改变从属关系和顺序，操作方便。

目录与文档可以批量分享，也可以单独分享。分享的出去的文档不需要登录就可以查看，便于团队之间的资源共享。

sward支持多种文档类型，比如富文本、markdown等，适用于多种场景。还提供多种模版，帮助用户快速创建常用文档。而且集成kanass的事项，提高办公效率。还有分享与评论功能，让成员之间可以互相交流。

sward支持富文本、markdown两种文档类型，未来还会持续迭代，支持更多文档类型。

系统还内置周报、项目规划和执行、待办工作清单等多种模板，可以帮助用户快速创建常用文档。

sward 集成kanass，可以添加kanass事项到文档中，让用户可以快速查看详情

常用或者重要的文档可以收藏，便于查看。

知识库管理软件为员工提供了一个共享和交流知识的平台，可以通过评论、点赞、分享等方式实现知识的共享和讨论

不常用的文档或者不用的文档可以归档起来，不在目录树中展示，便于常用文档的查找

不用的文档和目录可以放入到回收站，放入回收站的可以恢复或者删除，避免文档问误删。

sward 做到了简洁易用，上手容易，安装配置简单。使用备份、日志审计、权限保证数据安全。而且支持多版本多终端，集成开放，免费开源。

界面简洁，可直接使用；安装简单，支持一键式安装。

线下部署版本支持一键式安装，内置数据库，不用单独安装数据库，配置也只需要在一个文件中修改参数就可以；公有云部署版本注册即可使用。

界面简洁，但是功能丰富，色彩搭配和谐，有助于减轻用户的视觉疲劳

可导入confluence数据，集成kanass项目管理系统，并提供OpenApi，便于被第三方集成

注册一个账号，可用手机号与邮箱注册

登录进入工作台选择要点击sward，就成功的开通了sward，就可进入系统使用了

sward探索 :一款开源免费、简洁易用的企业级知识管理工具

        在数字经济时代，企业数字化转型已不再是选择题，而是必答题。然而，对于许多企业，尤其是中小企业而言，数字化转型之路并非坦途，面临着技术、资金、人才等多重挑战。

星光计划

针对 IntelliJ IDEA 环境推出 PostIn 插件，版本号1.0.1， PostIn 插件是一个针对 IntelliJ IDEA 环境的工具，集成到 IDEA 侧面板中，便于快速访问，帮助开发人员高效地管理API定义。插件可自动生成 API 文档并一键同步到 PostIn 的项目中。

一键智能解析：在IDEA中扫描JAVA代码，通过添加的注释自动识别接口路径、参数、返回值，无需手动整理！

全格式文档生成：秒级导出API标准文档，无缝对接PostIn平台！

动态同步更新：代码改动后，文档实时同步更新，杜绝“代码更新、文档滞后”产生的一系列问题！

自定义模板：支持团队统一配置文档样式、字段注释规范，让协作更专业！

省时省力：3秒生成100个接口文档，避免手工复制粘贴占用开发时间！

简单易用：无需配置复杂环境，安装即用，操作简单！

零误差：代码即文档，逻辑与描述100%一致，避免人为错误！

高效协作：代码与文档实时同步，解决了文档滞后代码、沟通成本高等一系列问题！

本节将详细介绍 PostIn 插件下载、安装。

方式1：在 IntelliJ IDEA 中安装 PostIn 插件。打开 IDEA 设置，进入 Plugins（插件）页面，搜索 “PostIn” 并安装 “PostIn” 插件。

方式2：在 Jetbrains Marketplace 中下载后通过本地安装

，打开 IDEA 设置，进入 Plugins（插件）页面，点击Installed右侧的设置按钮，选择"install plugin from disk... "，从磁盘安装插件。

插件仅支持 IntelliJ IDEA 2024.1.7 版本。

安装结束后，在idea右侧侧边栏显示PostIn。

本节将详细介绍 PostIn 插件配置。

进入插件后，显示扫描接口， 上报接口，设置三个按钮。

配置PostIn插件，点击“设置”按钮，进入PostIn插件的配置。

需要配置PostIn服务的URL（注意配置的URL尾部不需要带"/"），以及上报接口的所属空间ID，上报接口的所属空间ID可以在PostIn空间详情。

至此，PostIn上报接口的IDEA插件已全部下载、安装、配置结束。

本节将详细介绍怎么使用PostIn插件上报接口，生成详细的接口文档。

首先需要在接口文件controller 中添加注释，包含接口协议、导入接口文件夹名称、接口地址。

● @pi.protocol：定义了接口的协议。

● @pi.groupName：定义了接口的文件夹名称。

● @pi.path：定义了该接口的基本 URL 路径。

其次，需要在接口前添加接口详细信息的注释，包含接口名称、接口详细URL、请求方式、请求类型、请求参数。通过请求类型的不同，可以分为两种。

 * @pi.param: model=io.tiklab.postin.workspace.model.WorkspaceFollow

● @pi.name：定义了接口的名称。

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/createWorkspaceFollow

● @pi.methodType：定义了接口请求方式。

● @pi.request-type：定义了接口请求类型。

 * @pi.param: name=id;dataType=string;value=workspaceId;desc=当前删除的id

 * @pi.param: name=id2;dataType=string;value=workspaceId2;desc=当前删除的id2

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/deleteWorkspaceFollow

注释添加完成后，在PostIn插件点击“扫描接口”按钮，扫描当前项目所有接口。

扫描出接口后，用户可单选、多选或全选接口后提交上报。例如，接口总共有7个，按Ctrl选择其中3个，点击“上传接口”按钮，系统弹出”确认上传接口“二次确认弹窗。

点击“是”，选择的接口上传到PostIn系统。

当接口进行更新之后，还可以利用PostIn插件对接口进行更新。

接口成功上传PostIn后，对接口信息进行修改，只要接口路径（即@pi.path和@pi.url组成的路径）未进行修改，再次上传接口，会对当前接口进行更新。

接口路径（即@pi.path和@pi.url组成的路径）修改之后，再次上传接口，接口会按照新接口进行添加。

上报成功之后，可以在PostIn和 IntelliJ IDEA 环境信息对比。

下图为请求为字段，上报PostIn前后信息对比。

请检查配置的PostIn服务器URL是否正确，注意地址尾部不需要带"/"

PostIn V1.0.8版本发布，IDEA 插件支持一键扫描上报，让接口定义不再繁琐

系统全面支持各种附件的上传，上传后文件可以再次下载到本地，对部分文件支持在线预览

（1）登录系统后，选择您想要存储文件的知识库，并进入该知识库的文档页面，点击添加按钮即可找到上传本地文件链接。

找到”上传本地文件“的链接并点击

（2）点击链接后，会弹出选择本地文件的窗口，找到您想要上传的文件后，双击或者选中文件后点击打开按钮，文件自动上传到系统并展示在知识库左侧。

（3）您还可以按照自己的习惯新建目录，并将文件移动至特定目录，便于进一步整理和分类文件。

（4）上传后的文件可以继续下载到本地或分享给他人。

对于未解析文件，系统提供存储和下载