Skip to content

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

@gbinal

Description

@gbinal

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions