Главная
Study mode:
on
1
Welcome
2
10 Ways to Document Terminal Commands
3
The command line interface
4
Short commands that do useful things
5
Graphical User Interface
6
You want to achieve something?
7
In-line code
8
A code block
9
Screenshots
10
Generated images
11
Screencasts
12
Video as text
13
Version control
14
Video as code
15
Interactive terminal
16
A complex example
17
Bespoke code blocks
18
Wrap-up
19
Questions
20
The time is...
Description:
Explore 10 effective methods for documenting terminal commands in this informative webinar from Ubuntu OnAir's Documentation Office Hours. Delve into various approaches, from simple in-line code and code blocks to more advanced techniques like screencasts, version control, and interactive terminals. Learn how to create clear, user-friendly documentation for both novice and experienced command-line users. Discover the pros and cons of different documentation styles, including screenshots, generated images, and bespoke code blocks. Gain insights on making complex commands more accessible and understandable. Perfect for technical writers, developers, and anyone interested in improving their command-line documentation skills.

10 Ways to Document Terminal Commands - Documentation Office Hours

Ubuntu OnAir
Add to list
0:00 / 0:00