Tích hợp GitBook
Xuất bản hướng dẫn từng bước lên GitBook từ bản ghi màn hình
Chỉ cần thao tác tính năng một lần trên màn hình. Clevera sẽ viết trang hướng dẫn kèm ảnh chụp màn hình và xuất bản vào không gian GitBook bạn chọn, với các gợi ý, bước hướng dẫn, tab và khối mở rộng được xây dựng từ chính các khối của GitBook.
Khối GitBook nguyên bản
Hình ảnh được tải lên không gian
Cập nhật cùng một trang
Mọi gói GitBook
Bạn có thể làm gì
Tài liệu sản phẩm luôn bắt kịp mọi bản phát hành,
mà không cần người viết cho từng trang.
Các đội ngũ phát triển và sản phẩm chọn GitBook vì nó đẹp và có tổ chức. Điều nó không làm được là viết nội dung trang. Clevera sẽ lấp đầy các không gian của bạn bằng những hướng dẫn minh họa rõ ràng, được tạo từ bản ghi chính sản phẩm đó.
Một trang hướng dẫn cho mỗi tính năng
Ghi lại quy trình bạn vừa phát hành. Clevera sẽ viết trang hướng dẫn: phần giới thiệu, các bước được đánh số, ảnh chụp màn hình cho từng bước và các mẹo người đọc cần.
Khối GitBook, không phải văn bản dán
Các bước trở thành bước hướng dẫn (stepper) của GitBook, chú thích trở thành gợi ý, tab vẫn là tab, và mã nguồn giữ nguyên ngôn ngữ và tiêu đề. Trang trông như thể đội ngũ của bạn đã viết trực tiếp trong GitBook.
Ảnh chụp màn hình được lưu trong GitBook
Mỗi ảnh chụp màn hình được tải lên không gian dưới dạng tệp, vì vậy trang vẫn hoạt động ngay cả khi bài viết bị xóa trong Clevera.
Ghi lại khi giao diện thay đổi
Chỉnh sửa bài viết trong Clevera và xuất bản lại. Clevera tìm thấy trang và cập nhật tại chỗ, giữ nguyên địa chỉ và các liên kết của bạn.
Một không gian cho mỗi ngôn ngữ
Dịch bài viết trong Clevera, chuyển đổi ngôn ngữ trong trình chỉnh sửa và xuất bản từng phiên bản lên không gian chứa ngôn ngữ đó.
Không gian bạn chọn
Clevera kết nối bằng khóa truy cập cá nhân bạn tạo trong GitBook, và bạn chọn các trang tài liệu mà nó được phép xuất bản.
Cách thức hoạt động
Từ bản ghi đến trang GitBook
trong bốn bước.
Dán khóa GitBook một lần. Sau đó, mọi bài viết trong không gian làm việc đều có thể trở thành một trang trong tài liệu của bạn.
- 1
Kết nối bằng khóa
Tạo mã truy cập cá nhân trong cài đặt Nhà phát triển của GitBook, dán vào Clevera và chọn các trang của bạn. - 2
Clevera viết trang
Từ bản ghi màn hình của bạn, Clevera viết hướng dẫn: tiêu đề, các bước, gợi ý và ảnh chụp màn hình. - 3
Chọn không gian và xuất bản
Trong phần Chia sẻ, mở Xuất bản, chọn không gian GitBook và nhấp Xuất bản lên GitBook. - 4
Trực tiếp trong tài liệu của bạn
Trang xuất hiện ở cấp cao nhất của không gian, cùng với hình ảnh, ngay khi quá trình xuất bản hoàn tất.
Xem trong Clevera
Xuất bản lên GitBook,
từ cửa sổ Chia sẻ của bài viết.
Không cần xuất Markdown, không cần tải lại ảnh, không cần xây dựng lại các bước thủ công trong trình chỉnh sửa GitBook. Cửa sổ Chia sẻ cung cấp cho bạn liên kết và mã nhúng cũng đồng thời xuất bản lên GitBook.
Kết nối bằng khóa, được kiểm tra trước khi lưu
Dán mã truy cập cá nhân GitBook và nhấp Kiểm tra khóa. Clevera kiểm tra với GitBook trước khi lưu bất cứ điều gì, sau đó liệt kê các trang tài liệu của bạn, tất cả đều được chọn. Bỏ chọn bất kỳ trang nào bạn muốn Clevera không truy cập.
Khóa đóng vai trò như người dùng GitBook đã tạo ra nó. Một tài khoản tài liệu dùng chung giúp việc xuất bản hoạt động ổn định khi nhân sự thay đổi.
Chọn không gian để đưa trang vào
Danh sách hiển thị các không gian đằng sau các trang bạn đã chọn, như tài liệu sản phẩm và tài liệu API. Chọn một không gian và xuất bản. Clevera sẽ kiểm tra trước xem trang đã tồn tại ở đó chưa.
Địa chỉ của trang được lấy từ tiêu đề, vì vậy “Mời đội ngũ của bạn” trở thành /invite-your-team. Di chuyển hoặc đổi tên nó trong GitBook bất cứ khi nào bạn muốn.
Được điền sẵn cho bạn
Cách bài viết của bạn trở thành trang GitBook
từng khối một.
Clevera xây dựng trang từ các khối tài liệu của chính GitBook, vì vậy nó có thể chỉnh sửa như bất kỳ trang nào khác trong không gian của bạn. Dưới đây là nội dung của mỗi lần xuất bản.
- Không gianBạn chọn
- Bất kỳ không gian nào đằng sau các trang tài liệu bạn đã chọn khi kết nối. Thay đổi các trang bất cứ lúc nào với Kết nối lại.
- Tiêu đề và địa chỉ trangĐược thiết lập cho bạn
- Tiêu đề bài viết và địa chỉ được tạo từ đó, ở cấp cao nhất của không gian. Các tiêu đề có dấu hoặc bằng các bảng chữ cái khác sẽ được viết bằng ký tự Latin trước.
- Các bướcĐược chuyển đổi cho bạn
- Các bước được đánh số trở thành bước hướng dẫn của GitBook, một bước GitBook cho mỗi bước của bài viết.
- Chú thíchĐược chuyển đổi cho bạn
- Khối gợi ý: thông tin và ghi chú trở thành Thông tin, mẹo và thành công trở thành Thành công, cảnh báo trở thành Cảnh báo và nguy hiểm trở thành Nguy hiểm.
- Tab, nút chuyển đổi và mã nguồnĐược chuyển đổi cho bạn
- Tab vẫn là tab GitBook, các phần có thể thu gọn trở thành khối mở rộng, khối mã giữ nguyên ngôn ngữ và tiêu đề, và các phương trình sử dụng toán học của GitBook.
- Ảnh chụp màn hìnhĐược thiết lập cho bạn
- Được tải lên không gian dưới dạng tệp, kèm theo chú thích.
- VideoĐược thiết lập cho bạn
- Video và nội dung nhúng trong bài viết trở thành khối nhúng của GitBook. Video của Clevera được bao gồm khi liên kết chia sẻ của nó đang bật. Video gốc của bài viết không được thêm vào.
- Yêu cầu thay đổiĐược thiết lập cho bạn
- Clevera viết trang thông qua yêu cầu thay đổi của GitBook và hợp nhất ngay lập tức, vì vậy trang sẽ trực tiếp ngay khi quá trình xuất bản hoàn tất.
Thiết lập
Thiết lập tích hợp GitBook
trong khoảng hai phút.
Bạn cần một không gian làm việc Clevera gói Pro trở lên và bất kỳ gói GitBook nào. Chủ sở hữu không gian làm việc hoặc Quản trị viên kết nối GitBook một lần; sau đó, bất kỳ ai có quyền chỉnh sửa bài viết đều có thể xuất bản. Việc xuất bản không tốn tín dụng.
- 1
Tạo khóa truy cập GitBook
Trong GitBook, mở cài đặt tài khoản, đi tới Nhà phát triển, tạo mã truy cập cá nhân tên “Clevera” và sao chép nó. GitBook chỉ hiển thị nó một lần. - 2
Kết nối GitBook trong Clevera
Mở menu không gian làm việc, chọn Tích hợp, tìm GitBook và nhấp Kết nối. Dán khóa vào Khóa truy cập và nhấp Kiểm tra khóa. - 3
Chọn các trang của bạn
Dưới Các trang để xuất bản, giữ lại các trang tài liệu Clevera có thể sử dụng và nhấp Kết nối. Chưa có không gian nào? Clevera sẽ tạo một không gian tên “Clevera” cho bạn. - 4
Xuất bản bài viết
Trong trình chỉnh sửa bài viết, nhấp Chia sẻ, mở Xuất bản, nhấp vào ô GitBook, chọn một không gian và nhấp Xuất bản lên GitBook. - 5
Mở trong GitBook
Khi bạn thấy “Đã xuất bản lên GitBook.”, nhấp Mở trong GitBook để xem trang.
Câu hỏi về tích hợp GitBook
Clevera mở một yêu cầu thay đổi và hợp nhất ngay lập tức, vì vậy trang sẽ trực tiếp ngay khi quá trình xuất bản hoàn tất. Nếu mọi thay đổi trong tài liệu của bạn cần được xét duyệt trước, hãy xuất bản vào một không gian nháp và di chuyển trang từ đó sau khi được phê duyệt.
Ở cấp cao nhất của không gian bạn chọn. Sau đó, bạn có thể di chuyển nó vào nhóm phù hợp hoặc dưới một trang cha trong GitBook, và đổi tên nếu muốn.
Clevera tìm kiếm trang có cùng tiêu đề hoặc địa chỉ và hỏi bạn muốn làm gì. Cập nhật để thay thế tiêu đề và nội dung trong khi giữ nguyên địa chỉ, hoặc tạo trang mới với tiêu đề mới. Các chỉnh sửa thực hiện trong GitBook sau đó sẽ bị ghi đè bởi bản cập nhật, và lịch sử của GitBook cho phép bạn khôi phục chúng.
Không. Việc xuất bản chỉ diễn ra một chiều, từ Clevera sang GitBook. Hãy giữ bài viết trong Clevera làm nguồn và xuất bản lại sau khi bạn thay đổi.
Không phải từ phía Clevera. Nó thuộc về người dùng GitBook đã tạo ra nó, vì vậy nếu họ mất quyền truy cập vào tổ chức của bạn, việc xuất bản sẽ dừng lại. Xóa khóa trên trang Nhà phát triển của GitBook để thu hồi nó.
Không. Tích hợp này giữ tài liệu của bạn trong GitBook và thêm các trang vào đó. Nếu bạn muốn lưu trữ trung tâm trợ giúp của mình với Clevera, hãy xem nhập GitBook miễn phí và cách Clevera so sánh với GitBook.
Xuất bản lên GitBook là một phần của các gói Pro và Custom của Clevera và không sử dụng tín dụng; việc tạo bài viết vẫn sử dụng tín dụng như bình thường. Mọi gói GitBook đều hoạt động, miễn là người dùng sở hữu khóa có quyền chỉnh sửa không gian đó. Xem bảng giá.
Phát hành tính năng. Trang GitBook sẽ theo sau.
Ghi lại một lần. Clevera sẽ viết hướng dẫn và xuất bản lên không gian của bạn, bao gồm cả ảnh chụp màn hình.