documenting your project within Git in an editor navigation friendly manner.

So, I'm part of a team that currently has their documentations split up into an Azure DevOps wiki attached to a project, some SharePoint nonsense, a few read me files, and work items that capture the documentation to some degree but will of course be lost over the course of time because that's how these things tend to play out.

Personally I'm a fan of the idea of co-locating code and documentation as much as possible, particularly if it aids discovery.

We mostly use visual studio and visual studio code as our IDEs, something that is easy to cross navigate between source files and design documentation files would be fantastic, especially if they can contain rich formatting. Something like markdown sounds great to me, but I don't remember if markdown in visual studio really supports relative path references properly for visual studio code.

I'm looking for suggestions of how to have rich integration between code and documentation co-located within the repository in a navigation friendly way. Thank you in advance for any suggestions you may have.

submitted by /u/FirosoHuakara
[link] [comments]

from Software Development – methodologies, techniques, and tools. Covering Agile, RUP, Waterfall + more! https://ift.tt/3ANNJUC

Leave a comment

Design a site like this with WordPress.com
Get started
search previous next tag category expand menu location phone mail time cart zoom edit close