本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- OpenMRS.org
- 技术文档工程师：
- Ayeshmantha
- 项目名称：
- 为 REST API 编写人性化的 GithHub 文档
- 项目时长：
- 标准时长（3 个月）
Project description
该项目的主要目标是编写一个交互式文档，最终用户可以在该文档中通过试用选项与 API 进行互动，同时提供更具描述性和自我解释的描述，向技术人员和非技术人员解释哪些情况下应使用该端点。
目前的环境非常好，但对于非技术人员和技术人员而言，如果没有适当的文档，直接产生想法是更困难的。主要思路是将这种华丽的环境和文档放在一个地方，并呈现出很好的呈现效果。借助 JS、HTML 和 CSS。