3 ms·
Something to be cognizant of when creating this "keystone" doc - not losing it on some "share" that nobody can find anymore. Thus, the use of README in the roo
by Roboprog 9y ago
Something to be cognizant of when creating this "keystone" doc - not losing it on some "share" that nobody can find anymore.
Thus, the use of README in the root directory of a project.
- chiph 9y agoSince it would contain the location of the root directory, putting there would be circular. Hopefully the organization has a central location for their documentation that is somewhat organized (via SharePoint, or even a network share with folders). Reducing the number of things that a new hire would need to "just know" to a minimum should be a goal.
- joobus 9y ago> Hopefully the organization has a central location for their documentation that is somewhat organized... My office uses a combination of Redmine, Slack, email, gitlab, network drives, google docs, dropbox, some pdfs floating around, and a readme in the root of each repo...
- Roboprog 9y agoExactly. Because... It started out on... That Novell drive ... but then... That Win95 share ... Samba ... Wiki ... Sharepoint ... nah, let's start using Confluence now etc.
- Roboprog 9y agoIf you have it, it's nice to have a build/CI server that has a UI showing all the projects in a dept/work-group and where they come from in source control.