Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Wishlist: Documentation #41
I asked @JeremiePat about a good documentation strategy for Janitor, and he sent me this fantastic email:
Additionally, I think we should:
If you have another idea that could improve Janitor's documentation, please comment below. Thanks!
I think that the TaskCluster tutorial is clear and simple, and it's amazing that it guides you to the most relevant information for what you wish to do. I'd love us to have a similar tutorial.
Edit: A great and simple way to continuously improve the questions at the bottom would be to have a "Missing question?" input field just below with a "Suggest" button (that says "Thank you" when you suggest a new question).
Edit 2: Phabricator's docs (generated by their "Diviner" tool) also have Next Steps / "Continue by" links at the bottom of pages, and they would also benefit from a "Missing link?" suggestion box.