Showing results for 
Search instead for 
Did you mean: 
Copilot Lvl 2
Message 1 of 2

Development Requirements in .md files

I am investigating documenting/storing software development requirements in GitHub markdown files. I see major advantages to having the requirements stored with the code rather than a separate tool that engineers have to access.  As we start to release more frequently, I think the pull request functionality will help to get reviews and changes done faster. 

Curious if there are others that do this, what you find beneficial, and if there is anything to be cautious about. 

1 Reply
Commander Lvl 1
Message 2 of 2

Re: Development Requirements in .md files

Hey! If it's a public repo, you can render the Markdown files to the GitHub pages website. Also, consider moving the docs to the Wiki for the repo that way the engineers don't have to browse the code to look for info.