A Story about Writing Documentation
When I was younger and starting my career, developers around me always said writing documentation was tedious.
It’s a task for beginners and junior developers with limited experience.
I never understood why.
I have found many bugs and inconsistencies throughout my career while writing documentation.
For example, things change during development, are renamed, or the behavior of a feature slightly changes.
After all these years in the industry, I’m convinced that writing documentation or tutorials is an important step in helping other developers get into the topic and guaranteeing and improving the quality of our products.
This week, I wrote three articles and started working on a fourth article.
I wasted two full business days for the first article because I couldn’t make a Blazor WebAssembly application work with SignalR as I intended.
During the writing process, I learned a lot. For example, I implemented a Controller in the server project but forgot to enable controller support in the Program.cs file.
I usually work in ASP.NET Core WebAPI projects where Controller support is enabled by default.
That’s not the case for other .NET web application types, such as Blazor WebAssembly applications.
This week told me once again that writing tutorials, recording videos, or documenting features of an application is not wasted time.
It’s an excellent way to improve knowledge and find inconsistencies or bugs.
I encourage you to view writing documentation and tutorials as tasks on the same level as implementing new features because they are as valuable to overall software development as writing code.
Because of all the writing, I haven’t published a new video this week. However, you can watch my latest video about Getting Started with Docker for .NET development. The video got a great response.
ZTM Black Friday
I didn’t want to make a big deal out of it or write a clickbait headline. I’m sure you received enough of Black Friday ads these days.
However, Zero To Mastery is currently running the biggest sale ever.
You can get 58% off the subscription with the code BFCM24 and a chance to win a brand-new MacBook Pro.
The subscription included access to my C# and .NET course and over 100 additional courses by industry-leading experts.
That’s enough about that, you can find out yourself.
PREMIUM CONTENT
