News for hackers. Stuff that matters.
Re:How to Improve a Legacy Codebase by Roboprog on Tuesday May 30, 2017 @11:00PM (#14450152)
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.

Re:How to Improve a Legacy Codebase by chiph on Wednesday May 31, 2017 @09:19AM (#14452224)
Since 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.
Re:How to Improve a Legacy Codebase by joobus on Wednesday May 31, 2017 @11:07AM (#14453088)
> 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...

Re:How to Improve a Legacy Codebase by Roboprog on Thursday June 01, 2017 @02:24AM (#14458372)
Exactly. Because...

It started out on...

That Novell drive

... but then...

That Win95 share

... Samba

... Wiki

... Sharepoint

... nah, let's start using Confluence now

etc.

Re:How to Improve a Legacy Codebase by Roboprog on Thursday June 01, 2017 @02:20AM (#14458356)
If 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.