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

📝 Documentation: Categorisation #2828

Closed
6 tasks
Tracked by #2825
Gary-H9 opened this issue Jan 8, 2024 · 1 comment
Closed
6 tasks
Tracked by #2825

📝 Documentation: Categorisation #2828

Gary-H9 opened this issue Jan 8, 2024 · 1 comment
Labels
data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools

Comments

@Gary-H9
Copy link
Contributor

Gary-H9 commented Jan 8, 2024

As per the epic:

"Document where certain types of documentation ought to be stored. i.e. if writing a process for a user this should go in X. If writing an technical document that should be created in Y by default."

Define where:

  • User facing documentation should be created.
  • Platform documentation should be created.
  • Other types of documentation not mentioned here should be detailed and noted.
  • All of the above should be recorded in one location to be referred to in future.
  • Capture output in ADR
  • Capture in ways of working
@julialawrence
Copy link
Contributor

Following the principles of other teams -- runbooks: internal, user guide: external

@github-project-automation github-project-automation bot moved this from 👀 TODO to 🎉 Done in Analytical Platform Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools
Projects
Archived in project
Development

No branches or pull requests

2 participants