Decisions records are a generic version of architecture decision records, a lightweight type of documentation for recording decisions that have a significant impact on a codebase. Decision records can be useful for many types of decisions, not just those relating to software architecture. To enable project teams to easily use decision records in their documentation, publish a tool-agnostic template and set of best practices for decision records on wiki.
Research and template: https://www.mediawiki.org/wiki/User:APaskulin_(WMF)/Decision_records
To do
- Research popular templates and write a decision record for choosing or adapting one
- Get feedback and update draft
- Move userpage to Documentation/Decision_records
- Make new page discoverable from Documentation
- Added to Documentation/Toolkit
- Share with teams working on decision records
- API platform
Wikimedia examples
- https://doc.wikimedia.org/codex/latest/using-codex/adrs/overview.html
- https://gitlab.wikimedia.org/toolforge-repos/api-spec-reader/-/blob/main/docs/en/decision-records.md
- https://www.mediawiki.org/wiki/Architecture_decision_record_template
- https://www.mediawiki.org/wiki/Wikimedia_Search_Platform/Decision_Records/Recommendation_Flags_in_Search
- https://www.mediawiki.org/wiki/File:Decision_Record_TEMPLATE_pdf.pdf
- https://wikitech.wikimedia.org/wiki/Wikimedia_Cloud_Services_team/EnhancementProposals/Decision_record_template
- https://wikitech.wikimedia.org/wiki/Wikimedia_Cloud_Services_team/EnhancementProposals
- https://www.mediawiki.org/wiki/Wikimedia_Product_Infrastructure_team/Push_Notifications_Infrastructure/Design_Decisions
- https://www.mediawiki.org/wiki/Core_Platform_Team/Decisions_Architecture_Research_Documentation/Dropping_Abstract_Schema_Support_For_Oracle_and_MSSQL
- https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Ongoing_Efforts/Toolforge_Build_Service/Reports#Decision_records
- https://meta.wikimedia.org/wiki/Toolhub/Decision_record