-
Notifications
You must be signed in to change notification settings - Fork 8
Home
Examples are good. They help templateers demonstrate how a template works and they help readers understand a complex concept. We want to avoid using ‘foo’ and ‘bar’ - the Lorem Ipsum of code placeholders. We’re working to create a fake software product: The Chronologue.
In addition to providing an example for good documentation, we chose to stick with an example project for these reasons:
- To test the good docs project (TGD) templates and create a feedback mechanism for improving the quality of TGD templates.
- To give examples of what not to do without picking on an existing project's documentation and hurting anyone's feelings.
- To create and maintain the content - so it doesn't become dated.
The Chronologue is a fictional telescope that can look into the past, and make predictions for the future, too. Users can watch pre-rendered events on a website, or submit requests for new events to be recorded. What we’re currently up to:
- Specifying an API to retrieve data
- Prototyping user journeys and wireframes
- Building a prototype of a website
- Our goal is serve as an example that templateers and documentarians can use to demonstrate what good docs look like.
Everyone is welcome to come and play with us. If you’ve always wanted to create a fake API or design a fake UI, this is the group for you. Join us on slack