Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rdagumampan/adr-ps
A Powershell-based lightweight Architecture Decision Records (ADR) tool
https://github.com/rdagumampan/adr-ps
adr adr-powershell adr-ps agile-documentation architecture-decision-records
Last synced: about 1 month ago
JSON representation
A Powershell-based lightweight Architecture Decision Records (ADR) tool
- Host: GitHub
- URL: https://github.com/rdagumampan/adr-ps
- Owner: rdagumampan
- Created: 2018-09-06T21:17:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-08T17:37:39.000Z (about 6 years ago)
- Last Synced: 2024-05-18T06:34:03.664Z (4 months ago)
- Topics: adr, adr-powershell, adr-ps, agile-documentation, architecture-decision-records
- Language: PowerShell
- Homepage:
- Size: 17.6 KB
- Stars: 6
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - rdagumampan/adr-ps - A Powershell-based lightweight Architecture Decision Records (ADR) tool (PowerShell)
README
# ADR-PS
A Powershell based command-line tool for working with [Lighweight Architecture Decision Records (ADRs)](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
>"Lightweight Architecture Decision Records is a technique for capturing important architectural decisions along with their context and consequences. We recommend storing these details in source control, instead of a wiki or website, as then they can provide a record that remains in sync with the code itself. - Thoughtworks"
## Quick Start
ADR-PS is a powershell module you can import in a normal powershell session. The default destination directory is `doc\adr`.
1. Copy the adr.psm1 into your solution folder and change the `doc\adr` into your desired directory.
2. Open Powershell CLI and import module
```powershell
/ powershell –ExecutionPolicy Bypass
/ Import-Module .\adr.psm1
```
3. Create an ADR repository in the current script location
```powershell
/ Adr-Init
```
4. Create architecture decision record
```powershell
/ Adr-New "Record architecture decisions"
```
```powershell
Directory: C:\play\adr-ps\doc\adr
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 9/8/2018 07:50 419 0001-record-architecture-decisions.md
-a---- 9/8/2018 07:43 125 ReadMe.md
```
5. Help
```powershell
/ Adr-Help
```
## Updating module
```powershell
/ powershell –ExecutionPolicy Bypass
/ Remove-Module adr
/ Import-Module .\adr.psm1
```
## Motivation
ADR-PS aims to help document architecturally significant functional and non-functional decisions through out solution lifetime to benefit current and future teams. I also hope to promote ADR-technique into greater audience with more choice of tools.
The decisions on this tool are recorded as [architecture decision records in repository](https://github.com/rdagumampan/adr-ps/tree/master/doc/adr)
## References
- http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
- https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records