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

Define process for ensuring docs and code stay in sync #611

Closed
3 tasks
Tracked by #629
jmcook1186 opened this issue Apr 10, 2024 · 2 comments
Closed
3 tasks
Tracked by #629

Define process for ensuring docs and code stay in sync #611

jmcook1186 opened this issue Apr 10, 2024 · 2 comments
Assignees

Comments

@jmcook1186
Copy link
Contributor

User story

As a user, I want to be able to read documentation and be confident it applies to the latest stable version of IF.

Rationale

There have been several cases where documentation changes have been missed when the code has changed, and this has caused the documentation to fall out of sync with the source code. This has been picked up by user feedback faster than it has been picked up by the core team on several occasions. To avoid this, we need to implement a process to keep the documentation and the source code in sync.

Implementation details

  • create process proposal
  • discuss with core team
  • implement, spawning additional tickets if necessary

Priority

4/5

Size

S

What does "done" look like?

Process implemented

Deadline

tbc

@jmcook1186 jmcook1186 added this to IF Apr 10, 2024
@jmcook1186 jmcook1186 self-assigned this Apr 11, 2024
@jmcook1186 jmcook1186 added this to the Sprint 11 / QA1 milestone Apr 11, 2024
@jmcook1186 jmcook1186 moved this to Backlog in IF Apr 11, 2024
@jawache
Copy link
Contributor

jawache commented Apr 16, 2024

@jmcook1186 I would merge this with #613 (which I've proposed we broaden our to document our process), the same goes for testing, an issue is not ready to be worked on unless any and all testing requirements have been added to the acceptance criteria and SoW and any and all documentation requirements have beed added to the acceptance criteria and SoW for any issue.

It should just be part of the refinement processes, we can put reminders in the issue template or other nudges or ceremonies if it's not working, but makes sense to discuss this all on that one ticket so we don't have to jump around different tickets to have a conversation about refinement.

@jmcook1186
Copy link
Contributor Author

ok, closing as redundant

@github-project-automation github-project-automation bot moved this from Backlog to Done in IF Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants