Главная
Study mode:
on
1
Intro
2
What engineering is about
3
What documentation is about
4
Colleague enablement
5
Diataxis
6
Content structure
7
Style guide
8
Docs as code
9
Source control
10
Text-based markup & diagrams
11
Automating a docs platform
12
Continuous integration
13
Vale
14
Continuous Deployment
15
Open source operation
16
Contributors
17
Maintainers
18
Engineering documentation
19
Resources
20
Outro
Description:
Explore best practices for creating excellent engineering documentation in this 47-minute conference talk from GOTO Copenhagen 2022. Learn how to apply good engineering practices to documentation, including docs-as-code for change management, pull request workflows for collaboration, and CI/CD for quality assurance. Discover the Diataxis framework for structuring content, implement style guides, and leverage text-based markup and diagrams. Dive into automating documentation platforms, using continuous integration tools like Vale, and managing open-source documentation projects. Gain insights on colleague enablement, content structure, and maintaining documentation as code to enhance the developer experience and create more delightful technical resources.

Engineering Documentation

GOTO Conferences
Add to list