Chronologue docs: How Chronologue API works - Githubissues

thegooddocsproject / chronologue

Fictional project for writing examples in The Good Docs templates.

Creative Commons Attribution 4.0 International

8 stars 8 forks source link

Chronologue docs: How Chronologue API works #10

Open kickoke opened 2 years ago

kickoke commented 2 years ago

Summary

"How Chronologue API works" is a Concept that provides Scientists and Developers with an overview of the API architecture on a higher level.

Research

[ ] Determine user goals.
[ ] Determine prerequisites
[ ] Determine what steps the user has to take.

Writing/Testing

[ ] Create a new branch.
[ ] Create a draft.
[ ] Write a commentary in the document to highlight best practices.
[ ] Take feedback notes for the template group.
[ ] Create a PR.

Review

[ ] Grammatical review.
[ ] Technical review.

Publication

[ ] Merge PR to docs.

Resources

Source file: API overview Template: Overview Feedback form: INSERT LINK