Category: Code documentation

Documenting your codebase

Swimm - default blog image
Documentation in Python: Methods and Best Practices
Oct 23, 23 8 min read

What Is Documentation in Python?  Documentation in Python refers to the written text that...

Swimm - default blog image
Code Documentation in C#: Inline Comments, XML Comments, and More
Oct 16, 23 9 min read

What Is Code Documentation in C#?  Code documentation is the comprehensive explanation of how...

Swimm - default blog image
Code Documentation Javascript: Methods and Best Practices
Oct 12, 23 5 min read

What Is JavaScript Code Documentation?  JavaScript code documentation is a detailed explanation of JavaScript...

Swimm - default blog image
3 code documentation examples and lessons learned
Mar 5, 23 6 min read

Exploring three types of code documentation examples including internal, external, and walkthrough documentation.

Swimm - default blog image
7 reasons continuous integration documentation is a must
Feb 23, 23 7 min read

Continuous integration documentation helps teams automatically check for outdated code and update docs. Save...

Swimm - default blog image
Agile Documentation: Benefits and Best Practices
Jan 3, 23 10 min read

Agile documentation is an approach to creating documentation for software development projects that follows...

Swimm - default blog image
Internal documentation in software engineering: 3 tips for success
Jan 3, 23 5 min read

Internal documentation in software engineering is the source of truth that keeps products and...

Swimm - default blog image
Why you need a coding diagram and 6 tools to get you started
Dec 8, 22 8 min read

Technical diagrams improve developer onboarding but quickly become outdated after publication. Learn how coding...

Swimm - default blog image
Code documentation: benefits, challenges, and tips for success
Nov 30, 22 13 min read

Code documentation is a collection of programmer comments explaining how code works and how...

Swimm - default blog image
Documentation as Code: why you need it and how to get started
Nov 28, 22 8 min read

Documentation as Code (DaC) is a way for technical writers and developers to create...