Dự án Tài nguyên quốc gia về sinh học mạng (NRNB)

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ở:
Tài nguyên quốc gia về sinh học mạng (NRNB)
Người viết nội dung kỹ thuật:
Rahul Agrawal
Tên dự án:
Cải thiện tài liệu Cytoscape.Js
Thời lượng dự án:
Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

# Làm cho tài liệu về Cytoscape.js dễ tiếp cận hơn với người mới.

Theo thông số kỹ thuật do người cố vấn đưa ra, tôi đã chia dự án thành hai danh mục và tôi muốn triển khai các tính năng này cho dự án này. Tôi đã sắp xếp theo thứ tự giảm dần mức độ ưu tiên.

  • Tính năng chính (Ưu tiên hàng đầu)

    – Giai đoạn 1

  • Di chuyển thông số kỹ thuật JSON hiện có kèm theo thông tin tham chiếu đến tệp Markdown sang nhận xét trên JSDoc

  • Tinh chỉnh và cải thiện tài liệu hiện có, chẳng hạn như viết nội dung mô tả tốt hơn hoặc thêm các đoạn mã mẫu khác

    – Giai đoạn 2

  • Viết video hướng dẫn mới và tạo video xoay quanh các chủ đề mới hoặc chủ đề cơ bản theo những cách hấp dẫn hơn.

    – Giai đoạn 3

  • Viết bản minh hoạ mới và tạo video để giúp người dùng hiểu được một ứng dụng web Cytoscape hoàn chỉnh sẽ như thế nào.

  • **Mục tiêu xa hơn **

  • Một số điểm cải tiến chung về tài liệu.