No video

Writing great documentation

  Рет қаралды 38,369

Igor Starikov

Igor Starikov

Күн бұрын

Пікірлер: 13
@gerardozelaya9182
@gerardozelaya9182 4 жыл бұрын
Thank YOU!!!! This is a must hear - great presentation.
@rizzleriz4457
@rizzleriz4457 4 жыл бұрын
Have anyone ever heard of technical writers? ...coders are often busy. Have a tech writer beside them during coding...
@neol07707
@neol07707 4 жыл бұрын
"Preach about documentation" I Looove it
@somarble
@somarble 3 жыл бұрын
Considering how most software products developed by engineers suck (read "Why Software Sucks...and What You Can Do About It"), giving engineers tasks of writing docs positions the complete SDLC for disaster.
@dom3225
@dom3225 3 жыл бұрын
I'm not a developper but I write docs better than the devs I work with even though I had zero programming knowledge prior to this job. This is such a skewed view of things.
@bitsalt
@bitsalt 3 жыл бұрын
“Great documentation is written by great developers.” Well...this is occasionally true. Not all great developers are great at communicating their knowledge. Docs from the developer are most often a good starting point for someone who knows how to structure and communicate that information.
@albertbagd
@albertbagd 2 жыл бұрын
Great presentation! The only thing I can't agree is about Reference docs. They MUST be generated automatically. Usually, there's huge amount of formal data that must be synced with source code. It's practically impossible to keep this in sync by hand. The English text is written by people; they create templates and documentation preprocessing tools fill out the necessary forms, e.g., tables, or create graphs and diagrams.
@Enka_S
@Enka_S 4 жыл бұрын
Very cool presentation. The suggestions are really helpful!
@maryam5759
@maryam5759 4 жыл бұрын
what about technical writers??
@DieFliegeinderSuppe
@DieFliegeinderSuppe 7 жыл бұрын
Good stuff, thanks for sharing
@avinash3413
@avinash3413 6 жыл бұрын
Preach :)
@danielkrajnik3817
@danielkrajnik3817 3 жыл бұрын
yes yes yes
@NMelis
@NMelis 6 жыл бұрын
ну блин, а то думал что с переводом(, блин как же достала не знать англ. язык
How good are you, really? Improving your technical writing skills.
1:12:02
Linux.conf.au 2012 -- Ballarat, Australia
Рет қаралды 99 М.
How to Write Documentation for People that Don't Read
28:53
Next Day Video
Рет қаралды 8 М.
а ты любишь париться?
00:41
KATYA KLON LIFE
Рет қаралды 3 МЛН
Кадр сыртындағы қызықтар | Келінжан
00:16
SPILLED CHOCKY MILK PRANK ON BROTHER 😂 #shorts
00:12
Savage Vlogs
Рет қаралды 47 МЛН
Visualise, document and explore your software architecture -  Simon Brown
57:26
What nobody tells you about documentation
30:52
PyCon AU
Рет қаралды 89 М.
Technical Writing Webinar - Technical Documentation Essentials
58:03
OSU Professional and Continuing Education
Рет қаралды 12 М.
"Stop Writing Dead Programs" by Jack Rusher (Strange Loop 2022)
43:04
Strange Loop Conference
Рет қаралды 435 М.
Stop Writing Classes
27:29
Next Day Video
Рет қаралды 933 М.
Software Planning and Technical Documentation
10:49
AltexSoft
Рет қаралды 143 М.
Modern Technical Writing, by Andrew Etter
1:02:03
STC Silicon Valley
Рет қаралды 12 М.
Software tools for creating awesome engineering documentation
13:09