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 Epic #2825

Closed
8 tasks done
Gary-H9 opened this issue Jan 8, 2024 · 2 comments
Closed
8 tasks done

📝 Documentation Epic #2825

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

Comments

@Gary-H9
Copy link
Contributor

Gary-H9 commented Jan 8, 2024

Summary

The purpose of this epic is to improve the state of documentation for the Apps and Tools team. This activity ought to occur in three threads.

  1. At the moment there are numerous locations where things are documented.
    a. If possible this should be reduced, with a bias towards using one technology to display documentation. This simplicity will mean less overhead in managing the documentation going forward. (issue here)
    b. 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. (issue here)
    c. Implement step a.
  2. Review documentation.
    a. Review user facing guidance first. Ensure that guidance is correct, up to date, adds value.
    b. Review internal documentation
    c. Prune where possible.
  3. Ensure a process is setup to ensure documentation is regularly reviewed.

List of issues in this epic

Other information

Discussions on documentation can be carried out in #data-platform-documentation-epic on Slack.

Additionally we ought to capture this ticket in this piece of work.

@julialawrence
Copy link
Contributor

Questions to address:

  • P&A strategy
  • Who do we align with?

Copy link
Contributor

github-actions bot commented Jun 1, 2024

This issue is being marked as stale because it has been open for 60 days with no activity. Remove stale label or comment to keep the issue open.

@github-actions github-actions bot added stale and removed stale labels Jun 1, 2024
@github-project-automation github-project-automation bot moved this from ⛰ Epic to 🎉 Done in Analytical Platform Jul 16, 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 epic
Projects
Archived in project
Development

No branches or pull requests

4 participants