Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do a fresh pass at articulating and engaging around best practices #54

Open
4 tasks
gbinal opened this issue Jun 23, 2020 · 0 comments
Open
4 tasks

Do a fresh pass at articulating and engaging around best practices #54

gbinal opened this issue Jun 23, 2020 · 0 comments

Comments

@gbinal
Copy link
Member

gbinal commented Jun 23, 2020

We've now gone through to make sure that all GSA APIs have met the requirements of the API Standards, but a next worthwhile focus would be on articulating some best practices for API documentation and going through all of the API docs to see where we have holes and pitching the API programs to update their docs accordingly.

The 'Other Considerations' section of the API Standards already seems to be where we're articulating some best practices, so here's a proposed path forward:

  • Clone the current inventory of public APIs that we use for the Standards, to start a tracking doc for the best practices.
  • Click through all of the docs and look back through previous API Usability sessions to brainstorm edits to the Other Considerations section.
  • Make columns for each best practice in the tracking doc.
  • Engage each API program with suggested edits/pull requests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant