Duy trì tài liệu

Bổ sung tài liệu

Website được chia thành các trang nhỏ để bạn bổ sung dần theo nhu cầu đọc và điều phối dự án.

Yêu cầu bổ sung theo một chủ đề#

Bổ sung vào mdocs.cosup.shop một trang con của MegaStacks Bot giải thích bộ nhớ: dữ liệu nào được lưu, phạm vi, cách sửa hoặc quên và tình trạng triển khai hiện tại. Dựa trên mã và tài liệu gốc; giữ cách trình bày dễ đọc.

Bạn cũng có thể yêu cầu thêm ví dụ, hình minh họa luồng hoặc giải thích một file cụ thể. Mỗi trang nên giải đáp một nhóm câu hỏi rõ ràng.

Giữ thông tin có nguồn#

Cuối mỗi trang có đường dẫn tài liệu gốc trong kho mã. Khi cập nhật, đối chiếu đặc tả, tiến độ và mã thuộc tính năng. Nêu riêng định hướng sản phẩm, mã đã viết và kết quả đã kiểm chứng.

Ngày đối chiếu là một mốc đọc tài liệu, không phải bằng chứng toàn bộ phần mềm đã được kiểm thử ở ngày đó. Website chưa tự đồng bộ nội dung từ kho mã.

Nơi cập nhật website#

Nguồn website nằm trong thư mục Megastacks_docs trên Desktop. Nội dung được quản lý tập trung trong content/pages.mjs; thư mục dist/ chứa các trang HTML đã sinh để publish.

Website dùng HTML, CSS và JavaScript tĩnh; không đọc cơ sở dữ liệu ứng dụng hoặc kết nối vào máy tính của bạn. Sau khi thay đổi, cần dựng lại, kiểm tra và publish phiên bản mới.

Tài liệu gốc để đối chiếu 2 nguồn

Đường dẫn trong kho mã MegaStacks. Đây là nguồn để kiểm tra hợp đồng và trạng thái, không phải liên kết tải mã công khai.

  • docs/README.md
  • docs/feature-development-workflow.md
MegaStacks DocsHiểu dự án. Làm việc có chủ đích.

Tìm cả khi không gõ dấu. Dùng Tab để chọn, Enter để mở.