Monday, August 27, 2018

Documentation of a solution - good idea or waste of time

Hi Guys

I work in a team, maintaining a ASP.NET solution with DAL, BL, web-application and a public web-api, and common use of DI (Dependency Injection)

As many other projects I have worked on, there is almost no documentation, except a lot of error-reports and requirement specifications of new features and modules.

I think about making a document with some ERD, class-diagrams, som texts about classes, what packages/libraries are used and so on.

There is very few comments in the code "the code is its own documentation" - but we use ReSharper - just to make som auto-generated comments.

- do you spend some time maintaining such kind of document?

- do you have some useful examples or ideas of documentations to get some overview of a solution?

- ... or is it waste of time?

Thanks

Documentation of a solution - good idea or waste of time Click here
  • Blogger Comment
  • Facebook Comment

0 comments:

Post a Comment

The webdev Team