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

Internal documentation #67

Open
afandian opened this issue Mar 4, 2019 · 0 comments
Open

Internal documentation #67

afandian opened this issue Mar 4, 2019 · 0 comments

Comments

@afandian
Copy link
Member

afandian commented Mar 4, 2019

Get documentation in a state where it contains all existing knowledge, is correct, and can support and be fully included in feature development. Remove doubt from the code.

Existing existing documentation may concern:

  • Development
  • Testing
  • Deployment & Operations

Definition of done:

  • One place for public docs, one place for development docs. Others removed.
  • Data flows upstream and downstream of the REST API are documented, and product managers for those identified. This will include internal APIs and services.
  • There are no outstanding TODOs, all have been removed and / or turned into issues.
@afandian afandian added the sprint-1 Sprint 1, 2019-03-04 label Mar 4, 2019
@afandian afandian added this to the elastic-search-migration milestone Mar 4, 2019
@afandian afandian removed the sprint-1 Sprint 1, 2019-03-04 label Mar 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

1 participant