本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- OpenMRS.org
- 技术文档工程师：
- Ayeshmantha
- 项目名称：
- 为 REST API 开发方便用户使用的 GithHub 文档
- 项目时长：
- 标准时长（3 个月）
Project description
该项目的主要目标是开发交互式文档，让最终用户能够通过试用选项与 API 互动，同时提供更具描述性和自解释性的说明，向技术人员和非技术人员说明应在何种情况下使用端点。
目前的 Swagger 环境非常棒，但对于非技术人员和技术人员而言，如果没有适当的文档，就很难直接获得相关信息。主要的想法是将这种华而不实的环境和文档放在一个地方，并展现出完美的呈现方式。借助 JS、HTML 和 CSS。