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

  Рет қаралды 2,217

Devoxx

Devoxx

Күн бұрын

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.
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 should you care about these docs, how do they serve your best interests (Yes, there’s more than one!) and what a wide impact it could make on employees and even on your entire organization.

Пікірлер: 2
@CDATASection
@CDATASection 8 ай бұрын
I find AsciDoc more powerful and expressive than Markdown, e.g. builtin tables
@NachtmahrNebenan
@NachtmahrNebenan Жыл бұрын
And try to write code as if it was documenting.
Writing great documentation
30:38
Igor Starikov
Рет қаралды 38 М.
LIFEHACK😳 Rate our backpacks 1-10 😜🔥🎒
00:13
Diana Belitskay
Рет қаралды 3,9 МЛН
iPhone or Chocolate??
00:16
Hungry FAM
Рет қаралды 40 МЛН
An Unknown Ending💪
00:49
ISSEI / いっせい
Рет қаралды 56 МЛН
API Documentation and Why it Matters
11:16
AltexSoft
Рет қаралды 21 М.
All about Technical Writing w/ Linda Ikechukwu
55:46
Gift Egwuenu
Рет қаралды 3,6 М.
Clear and Concise Technical Writing
59:29
Johns Hopkins Engineering for Professionals
Рет қаралды 17 М.
How Senior Programmers ACTUALLY Write Code
13:37
Thriving Technologist
Рет қаралды 1,5 МЛН
How to Start a Speech
8:47
Conor Neill
Рет қаралды 19 МЛН
Software Planning and Technical Documentation
10:49
AltexSoft
Рет қаралды 151 М.
Technical Writing Webinar - Technical Documentation Essentials
58:03
OSU Professional and Continuing Education
Рет қаралды 12 М.
LIFEHACK😳 Rate our backpacks 1-10 😜🔥🎒
00:13
Diana Belitskay
Рет қаралды 3,9 МЛН