Technical Documentation - How Can I Write Them Better and Why Should I Care? - Hila Fish

This talk was recorded at NDC's Copenhagen Developer's Festival. #cphdevfest #ndcconferences #code #developer #softwaredeveloper
Attend the next NDC conference near you:
ndcconferences.com
cphdevfest.com/
Subscribe to our RUclips channel and learn every day:
/‪@NDC‬
Gathering pieces of information for a task or a project is a wasteful act and could result in duplicated work done by different people.
Onboarding, your ability to maintain code or infrastructure and systems handover - Documentation plays a crucial part in all these processes.
So... how can we write technical docs in an easy way & why should we even do it?
In this talk, I’ll show you a structured way to write technical docs, without being a technical writer - So you will deliver highly valuable information to your audience, to your best ability.
I’ll explain why you should care about these docs, how do they serve your best interests (Yes, there’s more than one!) and what impact it could make on employees or even on your entire organization.

[@lpanebr]

"If you can't automate it, document it." I love this! ❤

[@radekradek9082]

Thank You for this presentation. I'm currently on a task to build good documentation for the team and external users. I already see I will use some of the points.

[@hilafish]

Awesome to hear that you're investing time in creating good documentation, and that you found my talk useful for this task! Thanks for sharing this with me :) Good luck and feel free to reach out if you want to consult some more about the documentation you're creating.

[@will_s_citylights]

QR code in this video is broken. Would have been nice to include the URL as well.

[@Reflekt0r]

Docusaurus is awesome 🦖

[@unexpectedkAs]

Nothing new or revolutionary here... And yet.
Its baffling to me that we have to keep reminding people. and that so msny people would never do it, or do it so badly.