Your path to high-quality and simple software documentation

-Guide for managers in software development-

Introduction:
In countless discussions with our customers, we have analyzed the biggest challenges in the internal documentation of software projects and the source code. We have summarized the most important information and findings for you.

 

ACTUAL state:
Most small and medium-sized companies combine four different types of documentation:

  • Manually created text-based documentation in an online wiki
  • An automatically generated documentation, e.g. the class structure using Doxygen
  • The third documentations are Readme.txt files in the Git repository
  • The fourth docs are comments directly in the source code.

The advantage of this combination is that each one has its strengths and that most of these tools are retained free of charge.

 

The disadvantages of this combination are:

  • The documentation is scattered in many different places
  • The documentaries are not linked to each other
  • That is why developers often have to search various sources for a long time to find the information
  • The visual documentation of the software architecture according to the C4 model is usually completely missing

The other chapters in the eBook:

  • Why is the documentation of software projects important?
  • What makes really good documentation?
  • Why software developers are reluctant to write documentation:
  • How to fix the problems now – simple and clear recommendations for action:
  • Visual documentation of the architecture: What is the C4 model?
  • Software architecture programs in comparison:

Download ebook (english)

Contact:

Innovirtual Software GmbH
Kommerner Str. 141
53879 Euskirchen

Email: info@innovirtual.de
Phone: 01515-4848-643
Scroll to Top