Dịch vụ phát triển GitHub giúp dự án token của bạn có diện mạo rõ ràng hơn

Bắt đầu với loại hỗ trợ mà kho lưu trữ của bạn cần

Một đánh giá hiện diện GitHub có thể tập trung vào tư vấn, cải thiện nội dung hoặc hỗ trợ tài liệu. Trước tiên, chúng tôi thống nhất kho lưu trữ nào quan trọng. Chúng tôi cũng thống nhất điều bạn muốn người truy cập hiểu.

Một số đội ngũ cần một góc nhìn mới về tài liệu công khai. Những đội khác đã tìm ra khoảng trống. Họ muốn trợ giúp để tài liệu dễ theo dõi hơn. Bảng dưới đây giúp bạn mô tả điểm xuất phát. Công việc có thể kết hợp các tùy chọn này khi phù hợp.

Đối với mỗi kho lưu trữ, chúng tôi tìm kiếm bước hữu ích tiếp theo cho người đọc. Họ nên hiểu dự án, tìm tài liệu liên quan hoặc biết cách đặt câu hỏi. Chúng tôi ghi nhận thông tin kỹ thuật còn thiếu thay vì điền vào khoảng trống bằng phỏng đoán. Người liên hệ kỹ thuật của bạn xác nhận chi tiết sản phẩm trước khi bất cứ điều gì được công bố.

Nếu cộng đồng công khai của bạn cần một sự chuyển tiếp rõ ràng hơn từ tài liệu kỹ thuật, chúng tôi cũng có thể kết nối công việc này với phát triển cộng đồng và tương tác. Mục tiêu là một lộ trình thực tế giữa kho lưu trữ và nơi đội ngũ của bạn thực sự trả lời câu hỏi.

Làm cho dự án dễ theo dõi hơn trước khi có sự chú ý

Thông tin kho lưu trữ rõ ràng mang đến cho người truy cập một điểm bắt đầu hữu ích khi dự án đang được thảo luận. Một đánh giá ngắn có thể giúp đội ngũ của bạn phát hiện các liên kết gây nhầm lẫn, thiếu ngữ cảnh và mô tả lỗi thời. Bạn có thể thực hiện việc này trước khi chia sẻ các tài liệu đó rộng rãi hơn.

Hãy tưởng tượng trưởng bộ phận vận hành của một dự án token non trẻ, vào tối trước một AMA. Họ nhận thấy liên kết dự án mở ra một kho lưu trữ không có điểm bắt đầu rõ ràng. Chúng tôi sẽ kiểm tra lộ trình công khai và xác định điều người mới cần đầu tiên. Sau đó, chúng tôi sẽ yêu cầu người liên hệ kỹ thuật xác nhận từ ngữ.

Loại đánh giá đó là về sự sẵn sàng, không phải thêm hoạt động vì mục đích riêng. Chúng tôi xem xét những gì một người có thể thấy. Chúng tôi cũng xem xét những gì đội ngũ có thể giữ chính xác. Kết quả có thể là một phần mở đầu README hữu ích hơn, một hướng dẫn thiết lập được đặt đúng chỗ hơn hoặc một lộ trình rõ ràng hơn để đặt câu hỏi kỹ thuật.

Giả sử dự án của bạn có hai kho lưu trữ: một cho công cụ và một cho ví dụ. Mô tả của chúng có thể không giải thích chúng liên quan với nhau như thế nào. Chúng tôi đánh dấu kết nối và đề xuất nơi giải thích thuộc về. Đội ngũ của bạn quyết định có thực hiện chỉnh sửa hay không. Một chủ sở hữu kỹ thuật kiểm tra nó trước.

Khi câu hỏi cộng đồng cần một nơi trú ẩn ngoài GitHub, quản lý cộng đồng và kiểm duyệt có thể hỗ trợ khía cạnh trò chuyện. Chúng tôi giữ hướng dẫn kho lưu trữ và lộ trình cộng đồng riêng biệt, để mỗi bên phục vụ một mục đích rõ ràng.

Một người đóng góp mới nên có thể hiểu được điều gì?

Một người đóng góp mới nên có thể hiểu dự án, tìm hướng dẫn liên quan và thấy cách thực hiện bước tiếp theo hợp lý. Chúng tôi xem xét các bước đó như một người truy cập. Sau đó, chúng tôi tách thông tin còn thiếu khỏi thông tin chỉ cần một vị trí tốt hơn.

Bắt đầu với một giải thích đơn giản

Kho lưu trữ nên làm cho mục đích và đối tượng của nó dễ nắm bắt. Chúng tôi kiểm tra xem mô tả và README có sử dụng thuật ngữ nhất quán không. Chúng tôi cũng kiểm tra xem chúng có trỏ đến tài liệu dự án hiện tại không. Nếu ngữ cảnh sản phẩm không rõ ràng, chúng tôi hỏi đội ngũ của bạn để có thông tin thay vì thêm giả định.

Làm cho hành động đầu tiên hiển thị

Hướng dẫn bắt đầu nên cho thấy những gì ai đó cần trước khi thử dự án. Hướng dẫn đóng góp nên phản ánh quy trình mà đội ngũ của bạn thực sự có thể hỗ trợ. Một bước tiếp theo hữu ích có thể là một cách được ghi lại để đặt câu hỏi hoặc đề xuất thay đổi. Chúng tôi xác nhận lộ trình đó với bạn.

Giữ sự chuyển tiếp rõ ràng

Nếu ai đó cần trợ giúp, họ không nên phải đoán kênh nào được giám sát. Chúng tôi có thể kết nối hướng dẫn kho lưu trữ với kế hoạch kích hoạt cộng đồng của bạn, trong khi vẫn giữ tài liệu kỹ thuật làm tài liệu tham khảo cho các chi tiết kỹ thuật.

Trước khi đánh giá, hãy thu thập hướng dẫn thiết lập hiện tại và đối tượng mục tiêu cho mỗi kho lưu trữ. Đồng thời chỉ định một người liên hệ có thể kiểm tra các tuyên bố kỹ thuật. Ví dụ, một đội ngũ có thể chỉ cho chúng tôi mô tả sản phẩm ưa thích và kênh hỗ trợ. Điều đó cho chúng tôi một cơ sở vững chắc để phát hiện ngôn ngữ không nhất quán và sự chuyển tiếp không rõ ràng.

Ba điểm kiểm tra đưa công việc từ liên kết đến các thay đổi có thể sử dụng

Đánh giá diễn ra qua ba điểm kiểm tra: hiểu dự án, kiểm tra tài liệu công khai và bàn giao các hành động đã thống nhất. Chúng tôi giữ công việc tập trung vào các kho lưu trữ và đối tượng bạn xác định.

1. Chia sẻ điểm xuất phát. Gửi liên kết kho lưu trữ, mô tả sản phẩm ngắn gọn và những người bạn muốn tài liệu phục vụ. Đề cập bất kỳ khu vực riêng tư hoặc nhạy cảm nào nên nằm ngoài đánh giá.
2. Thống nhất những gì chúng tôi sẽ kiểm tra. Chúng tôi xác nhận các kho lưu trữ và tài liệu. Chúng tôi cũng xác nhận liệu bạn cần đề xuất hay hỗ trợ nội dung, và ai có thể xác minh thông tin kỹ thuật.
3. Xem xét lộ trình người truy cập. Chúng tôi xem xét mô tả kho lưu trữ, nội dung README, liên kết tài liệu và hướng dẫn đóng góp. Các phát hiện được nhóm theo nhu cầu của người đọc và ai có thể hành động trên từng mục.
4. Cùng nhau kiểm tra thông tin. Người liên hệ kỹ thuật của bạn xem xét từ ngữ đề xuất và xác nhận chi tiết nào là chính xác. Chúng tôi để lại các tuyên bố về hành vi sản phẩm và triển khai cho đội ngũ của bạn xác minh.
5. Bàn giao công việc. Bạn nhận được danh sách hành động đã thống nhất và bất kỳ nội dung hoặc hỗ trợ tài liệu nào kèm theo, với quyền sở hữu được làm rõ.

Chúng tôi xác định thời gian sau khi xem số lượng kho lưu trữ và khối lượng tài liệu liên quan. Một người liên hệ duy nhất được chỉ định từ phía bạn giúp các câu hỏi kỹ thuật được giải quyết nhanh chóng. Nếu dự án của bạn cũng sử dụng phát triển cộng đồng Telegram hoặc phát triển cộng đồng Discord, hãy chia sẻ các điểm đến đó. Chúng tôi sau đó có thể kiểm tra cách GitHub hướng người truy cập đến chúng.

Giữ tài liệu công khai hữu ích sau khi đánh giá

Một hiện diện GitHub rõ ràng cần một chủ sở hữu sau khi đánh giá. Chi tiết kho lưu trữ và tài liệu có thể thay đổi theo sản phẩm. Chúng tôi giúp đội ngũ của bạn rời đi với các hành động thực tế tiếp theo, không phải một danh sách phụ thuộc vào hỗ trợ bên ngoài liên tục.

Đối với mỗi thay đổi đã thống nhất, chỉ định một chủ sở hữu và nơi cập nhật thuộc về. Hướng dẫn kỹ thuật cần một nhà phát triển xác nhận chúng. Mô tả dự án và liên kết cần ai đó có thể giữ chúng cập nhật. Một kiểm tra đơn giản có thể hỏi liệu README có còn khớp với sản phẩm không. Nó cũng có thể kiểm tra xem các liên kết chính có hoạt động không. Sau đó xác nhận liệu hướng dẫn đóng góp có phản ánh quy trình mà đội ngũ của bạn tuân theo không.

Chúng tôi có thể xem xét tài liệu công khai và hỗ trợ công việc tài liệu đã thống nhất. Đội ngũ của bạn kiểm soát quyền truy cập kho lưu trữ, quyết định xuất bản, chi tiết nhạy cảm về bảo mật và bảo trì liên tục. Giữ thông tin đăng nhập riêng tư và thông tin triển khai nhạy cảm ra khỏi tệp công khai. Yêu cầu chủ sở hữu kỹ thuật phù hợp phê duyệt các thay đổi trước khi xuất bản.

GitHub kiểm soát cách nó hiển thị hoặc đưa ra các kho lưu trữ. Người truy cập quyết định có đọc, chia sẻ hay đóng góp hay không. Chúng tôi cam kết thực hiện đánh giá và tài liệu đã thống nhất với bạn, không phải khả năng hiển thị trên nền tảng hoặc sự tham gia bên ngoài.

Nếu bạn đã sẵn sàng bắt đầu, hãy gửi cho chúng tôi các liên kết kho lưu trữ, mô tả dự án ngắn gọn và đối tượng bạn muốn tiếp cận. Chúng tôi sẽ xem xét điểm xuất phát với bạn, xác nhận ranh giới và thống nhất các bước tiếp theo.

Cách hoạt động

1. Chia sẻ bối cảnh dự ánGửi liên kết kho lưu trữ, mô tả sản phẩm ngắn gọn và đối tượng bạn muốn tiếp cận. Ghi chú bất kỳ thông tin nào nên được giữ riêng tư.
2. Thống nhất ranh giới đánh giáChúng tôi xác nhận kho lưu trữ và tài liệu nào cần kiểm tra, loại hỗ trợ bạn cần và ai có thể xác minh chi tiết kỹ thuật.
3. Xem xét và sắp xếp các phát hiệnChúng tôi xem xét trải nghiệm công khai và sắp xếp các hành động thực tế theo nhu cầu người đọc và quyền sở hữu.
4. Kiểm tra từ ngữ kỹ thuậtNgười liên hệ kỹ thuật của bạn xác nhận các chi tiết đề xuất trước khi đội ngũ của bạn xuất bản hoặc sử dụng chúng.
5. Nhận công việc đã thống nhấtChúng tôi bàn giao các hành động ưu tiên và bất kỳ nội dung hoặc hỗ trợ tài liệu nào kèm theo.