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

Chronologue docs: Chronologue API reference #14

@valeriahhdez

Description

@valeriahhdez

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions