{"id":16863584,"url":"https://github.com/vbrazo/designdocs","last_synced_at":"2026-03-18T22:43:19.240Z","repository":{"id":114253089,"uuid":"317370241","full_name":"vbrazo/designdocs","owner":"vbrazo","description":"Personal design docs template and examples","archived":false,"fork":false,"pushed_at":"2020-12-01T00:21:31.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-18T16:46:38.265Z","etag":null,"topics":["architecture","documentation"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vbrazo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-30T23:17:56.000Z","updated_at":"2023-03-24T00:08:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"1856b2ee-8793-48a4-bcac-ed9f9f788dbe","html_url":"https://github.com/vbrazo/designdocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vbrazo/designdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbrazo%2Fdesigndocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbrazo%2Fdesigndocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbrazo%2Fdesigndocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbrazo%2Fdesigndocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vbrazo","download_url":"https://codeload.github.com/vbrazo/designdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbrazo%2Fdesigndocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269970130,"owners_count":24505474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","documentation"],"created_at":"2024-10-13T14:39:04.169Z","updated_at":"2026-02-10T11:37:07.534Z","avatar_url":"https://github.com/vbrazo.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Design Solution\n\nThe development process is design-driven. Significant changes to the architecture, features, or tools must be first discussed, and sometimes formally documented, before they can be implemented.\nThis document describes the process for proposing, documenting, and implementing changes to the organization.\n\n* If you don't know what technology use, to solve your problem, there are two options:\n\n1 - Make a POC (proof of concept) with your options and open a Pull Request asking for validation, in this case everybody decides together.\n\n2 - Make the decision first, and submit the proposal to the group.\n\nBefore writing the design doc you can talk with others to evaluate what options you have talking about technologies solutions that are used and made before.\n\n## The Design solution process\n\nThe Design Solution process is the process for reviewing a proposal and reaching a decision about whether to accept or decline the proposal and split the implementation in small waves.\n\n 1. Open a specific branch to start write the Solution Design;\n 2. The proposal author open a Pull Request and in this time start async discussion whith the team through the PR review.\n 3. Schedule a Design Solution review meeting\n 4. The PR is blocked until we have at least 2 approving reviews. At this time we consider Design Solution approved.\n\n## Design Solution Documents\n\nDesign Solution Document will guide you to describe how the solution will be implemented and what kind of problem you are trying to fix.\n\n - The design doc should be checked in to specific feature/product repository as `designdocs/shortname.md`\n - The design doc should follow [the template](https://github.com/vbrazo/designdocs/blob/master/template.md)\n\n## Design Solution Review meeting\n\nThe main goal of the review meeting is to make sure that Design Solutions are receiving attention from the right people, by cc'ing relevant developers, raising important questions, pinging lapsed discussions, and generally trying to guide the discussion toward agreement about the outcome. The discussion itself is expected to happen on the issue tracker so that anyone can take part.\n\nThe Design Solution review meetings also identify issues where consensus has been reached and the process can be advanced to the next step (by marking the proposal accepted or declined or by asking for a split design doc in more design solutions).  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbrazo%2Fdesigndocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvbrazo%2Fdesigndocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbrazo%2Fdesigndocs/lists"}