All courses

Développement

Write the Technical Documentation for Your Project

Produce clear and maintainable documentation for your project with naming conventions, README, API documentation tools, and a technical architecture document.
Medium
6 hours
Interested in this free-access course?

To create a quality application, you need to make your code readable, understandable, and maintainable for all developers who might work on the project in the future. To do this, you need to communicate how your code works and how the application architecture is structured.

In this course, you’ll learn the best practices to make your code self-documenting, see how to create good documentation and publish it online, and find out how to document an API.

In the second part, we’ll look at some best practices for creating architecture documentation and the points you need to consider.

Your teachers on this course are Max Wardeh and Francis Bock.

Max Wardeh is a university lecturer and web development consultant. He has been working in web development for over 20 years. 

Francis Bock is deputy director of a European project providing geospatial services. He has taught back-end development at Gustave Eiffel University and formerly held the role of CIO for a French government department.

So, you want to provide the best possible experience for your colleagues when using your code and its documentation? Then let’s get started on the first chapter!

Learning outcomes

  • Document your code to make it maintainable and reusable
  • Create documentation for your architecture

Requirements

Prerequisites

Turn it into a career

Choose one of our 100% online degree programs, and transform your know-how into professional skills.

  • Up to 100% of your training program funded
  • Flexible start date
  • Career-focused projects
  • Individual mentoring

Contributors

Instructor

Max Wardeh

Experienced developer leading the architecture, development and delivery of web and mobile projects globally and in multiple languages.

Created by

Last updated: 1/23/2025
License

Développement

Write the Technical Documentation for Your Project

Medium
6 hours
Free-access course