Các khái niệm chính
Hiểu các thành phần cốt lõi của SpecDown giúp bạn tận dụng tối đa nền tảng.
Dự án
Dự án là container cao nhất cho tài liệu của bạn. Có thể coi như repository — chứa tất cả tài liệu, quản lý kiểm soát truy cập và theo dõi cài đặt đồng bộ Git.
Mỗi dự án có slug riêng (vd: my-api-docs) dùng trong link chia sẻ và CLI. Bạn có thể có nhiều dự án cho các team hoặc sản phẩm khác nhau.
Tài liệu & Thư mục
Tài liệu
File Markdown với tiêu đề, nội dung và đường dẫn duy nhất trong dự án.
Thư mục
Container nhóm các tài liệu liên quan. Thư mục có thể lồng nhau tùy ý.
Mỗi tài liệu và thư mục có full_path như guides/api/authentication. Đường dẫn này được dùng cho đồng bộ Git, CLI và link chia sẻ.
Vai trò & Quyền hạn
SpecDown dùng Kiểm soát truy cập theo vai trò (RBAC) ở cấp dự án. Mỗi thành viên được gán một trong năm vai trò:
| Vai trò | Đọc | Sửa | Quản lý thành viên | Xóa dự án |
|---|---|---|---|---|
| Owner | ✓ | ✓ | ✓ | ✓ |
| Admin | ✓ | ✓ | ✓ | ✗ |
| Editor | ✓ | ✓ | ✗ | ✗ |
| Viewer | ✓ | ✗ | ✗ | ✗ |
| Public | qua link | ✗ | ✗ | ✗ |
Vai trò được áp dụng ở cấp database qua Row-Level Security — kể cả truy cập API trực tiếp cũng tuân theo quyền hạn này.
Link chia sẻ
Mỗi tài liệu có thể chia sẻ qua link dựa trên token. Người xem không cần tài khoản SpecDown để đọc tài liệu chia sẻ.
| Loại | Gói | Mô tả |
|---|---|---|
| Công khai | Free | Ai có link đều đọc được |
| Có mật khẩu | Pro | Người xem phải nhập mật khẩu |
| Có thời hạn | Pro | Link tự động hết hạn sau ngày đã đặt |
Lịch sử phiên bản
Mỗi khi bạn lưu tài liệu, SpecDown tự động tạo snapshot phiên bản — nhưng chỉ khi nội dung thay đổi (phát hiện bằng SHA-256 hash). Điều này tránh lịch sử phiên bản bị đầy bởi các lần lưu giống hệt nhau.
Lịch sử phiên bản có sẵn trên gói Pro vàTeam.
Tổng quan gói
Free
1 dự án, 10 tài liệu, link chia sẻ công khai
Pro
Tài liệu không giới hạn, Git sync, MCP, lịch sử phiên bản
Team
Tất cả Pro + thành viên nhóm, bình luận, admin
Sẵn sàng bắt đầu?
Viết spec như code. Đồng bộ với Git. Chia sẻ với team.