Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Chronologue docs: Chronologue API reference #14

Open
1 of 11 tasks
valeriahhdez opened this issue Jun 11, 2022 · 0 comments
Open
1 of 11 tasks

Chronologue docs: Chronologue API reference #14

valeriahhdez opened this issue Jun 11, 2022 · 0 comments
Assignees
@valeriahhdez
Labels
documentation Improvements or additions to documentation

Comments

@valeriahhdez
Copy link
Collaborator

valeriahhdez commented Jun 11, 2022 •
edited
Loading

Summary

"Chronologue API reference" is an API reference that provides developers with a list of end-points.

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: https://github.com/thegooddocsproject/templates/tree/dev/api-reference
Template: https://github.com/thegooddocsproject/templates/tree/dev/api-reference
Feedback form: INSERT LINK
@valeriahhdez valeriahhdez added the documentation Improvements or additions to documentation label Jun 11, 2022
@kickoke kickoke assigned valeriahhdez and unassigned kickoke Jul 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@valeriahhdez valeriahhdez

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kickoke @valeriahhdez