DEV Community

Discussion on: What is your default documentation process?

Collapse
 
scottharrisondev profile image
Scott Harrison

For me, I like to have a README.md with technical details of what a project is setting out to do, how you can install it and what the requirements might be.

I also generally like to have a file that outlines who the project owners and contributors are (who the project manager is, who the designer is etc.) as well as explains the git flow we are using for this specific project.

I'm not super happy with this approach as I still feel like it isn't perfect.