Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- OpenMRS.org
- Người viết nội dung kỹ thuật:
- Ayeshmantha
- Tên dự án:
- Phát triển tài liệu GithHub thân thiện với người dùng cho API REST
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Mục tiêu chính của dự án là phát triển tài liệu tương tác, trong đó người dùng cuối có thể tương tác với các API bằng các tuỳ chọn dùng thử, đồng thời có nội dung mô tả chi tiết và tự giải thích hơn để giải thích cho những người có chuyên môn kỹ thuật và không chuyên về trường hợp nên sử dụng điểm cuối.
Môi trường khoa học hiện nay thật là tuyệt vời nhưng đối với những người không phải là người dùng công nghệ và công nghệ thì việc trực tiếp hiểu được ý tưởng mà không có tài liệu thích hợp vẫn còn rất khó khăn. Ý tưởng chính là đưa môi trường swagger và tài liệu này vào cùng một nơi với nội dung trình bày đẹp mắt. Với sự trợ giúp của JS, HTML và CSS.