https://github.com/ajoberstar/ArchitectureDecisionRecords
PowerShell module for creating/managing Architecture Decision Records
https://github.com/ajoberstar/ArchitectureDecisionRecords
architecture architecture-decision-records architecture-doc documentation
Last synced: 4 months ago
JSON representation
PowerShell module for creating/managing Architecture Decision Records
- Host: GitHub
- URL: https://github.com/ajoberstar/ArchitectureDecisionRecords
- Owner: ajoberstar
- License: mit
- Created: 2018-07-01T18:19:14.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-08-13T17:50:01.000Z (over 2 years ago)
- Last Synced: 2024-11-30T22:45:01.139Z (5 months ago)
- Topics: architecture, architecture-decision-records, architecture-doc, documentation
- Language: PowerShell
- Size: 21.5 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ajoberstar/ArchitectureDecisionRecords - PowerShell module for creating/managing Architecture Decision Records (PowerShell)
README
# ArchitectureDecisionRecords
[](https://www.powershellgallery.com/packages/ArchitectureDecisionRecords)
A PowerShell module for working with [ArchitectureDecisionRecords](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) (ADRs).
## What is it?
ArchitectureDecisionRecords provides PowerShell functions that let you work with ADRs in a method compatible with the Bash-based [adr-tools](https://github.com/npryce/adr-tools).
## How do I use it?
### Installation
Use PowerShellGet to install from PowerShell Gallery.
```powershell
Install-Module -Name ArchitectureDecisionRecords
```
### Starting from scratch
```powershell
Initialize-Adr
```
### Adding a new ADR
```powershell
New-Adr -Title 'Use a database'
New-Adr -Title 'Do not use a database' -Supersede 2
```
### Generating a TOC
```powershell
Reset-AdrToc
```
### For more help
```powershell
Get-Command -Module ArchitectureDecisionRecords
```
```powershell
Get-Help New-Adr
```