Главная
Study mode:
on
1
Welcome
2
Agenda
3
Why Alexandra started a blog
4
Alexandras goal
5
I am lost
6
Documentation is a tool
7
You are already writing
8
The kind of technical writing I do
9
Good docs
10
Cliffs Notes
11
Writing
12
Teaching CSS
13
Learning is a twostep process
14
Write documentation first
15
Writing is good for you
16
I love sprinkles
17
Confetti cake
18
Everyone agrees
19
Why are you creating documentation
20
Does your document exist to inform
21
Compliance
22
Why
23
Audience
24
Future Self
25
Reassignment
26
Internal documentation
27
Know your audience
28
The curse of knowledge
29
Spell out words
30
Define your deliverables
31
Write while you code
32
Google Publisher Tag
33
Bad Comments
34
Write a Readme
35
What Makes a Good Readme
36
Bonus Points
37
Stepbystep
38
Bad instructions
39
Templates
40
Release Notes
41
Bad Release Notes
42
Performance Improvement
43
Better Release Notes
44
You Can Now
45
X Now Does Y
46
X No Longer Does Y
47
Blog Posts
Description:
Discover how to enhance your code through effective documentation in this PHP UK Conference talk. Learn the importance of well-written instructions, informative code comments, clearly scripted screencasts, and smart information architecture in making complex code accessible to new developers. Explore the benefits of documentation for teaching, code handover, and self-understanding. Gain insights into various documentation types, including blog posts, internal documentation, READMEs, and release notes. Understand the significance of knowing your audience, avoiding the curse of knowledge, and defining clear deliverables. Master techniques for writing while coding, creating effective comments, and structuring informative release notes. Improve your technical writing skills and learn how documentation can benefit both you and future developers in this comprehensive guide to better code documentation.

Improve Your Code With Documentation

PHP UK Conference
Add to list