Updating SDD docs to include new Service page issues#309
Open
mariana-caldas wants to merge 2 commits into
Open
Updating SDD docs to include new Service page issues#309mariana-caldas wants to merge 2 commits into
mariana-caldas wants to merge 2 commits into
Conversation
✅ Deploy Preview for services-dev-webdevpath ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
Hi team! As soon as you approve this approach, I'll add the other issues to our That means that if we decide to add more issues or change anything in terms of our SDD architecture after merging this PR, our PM's (or myself) will open a new one so that we keep our specs as the project source of truth, which means where you are finding all the info you and your AI models need to code. |
mariana-caldas
requested review from
Dhemmyhardy,
Kaz-Smino,
LuSilvaDeveloper,
Satoshi-Sh,
bernardoasc,
briangesteban,
cherylli,
dami-boy,
emersonmellado,
klezi10,
liamgingell,
oluwatobiss,
sergiobtos,
shayla-develops-webs,
thorrellt and
tonykieling
and removed request for
dami-boy
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Have you updated the CHANGELOG.md file? If not, please do it.
Yes.
What is this change?
This PR continues the adoption of our Specification-Driven Development (SDD) workflow for the Services Page.
Instead of duplicating implementation details across the repository, the SDD documents define the product requirements, decisions, and supporting references, while GitHub Issues become the execution layer for individual implementation tasks.
This PR includes:
tasks.mdto reference GitHub Issues instead of maintaining duplicated implementation checklists.references.mdwith the latest design documentation and supporting resources.CHANGELOG.md.The remaining Services Page sections will follow the same approach as new implementation issues are created.
Were there any complications while making this change?
No technical complications.
This PR intentionally simplifies the relationship between the SDD documentation and GitHub Issues to avoid maintaining the same implementation details in multiple places.
The workflow may evolve as the team gains experience using it, and small improvements can be incorporated based on contributor feedback.
How to use this workflow
For every Services Page implementation task:
specification.mddecisions.mdreferences.mdtasks.md.The SDD documents remain the source of truth for requirements, decisions, and supporting references, while GitHub Issues manage implementation work and technical discussion.
How to test
No application functionality was modified.
Review the documentation changes to verify that:
tasks.mdcorrectly references the implementation issue.references.mdincludes the latest supporting documentation.When should this be merged?
After confirming that the proposed Specification-Driven Development workflow supports future Services Page implementation and that the updated documentation accurately reflects the intended development process.