Verbs Not Nouns: Writing Effective Documentation with Brian MacDonald

Verbs Not Nouns: Writing Effective Documentation with Brian MacDonald

Brian MacDonald, Manager of Technical Editing at DigitalOcean joins me to discuss the importance of writing efficient documentation for any product.

In this episode, Brian and I chat about his talk at All Things Open entitled Verbs Not Nouns and covering the importance of writing documentation that instructs your users on how to use your product to solve the problem it intends to solve for them. We also cover common mistakes in writing documentation and tips for ensuring yours is effective. Listen to hear Brian's advice and resources to improve your documentation.


Highlights:

  • Brian introduces himself and his role at DigitalOcean (0:47)
  • Why does documentation matter? (3:29)
  • The most common mistake people make with documentation (7:07)
  • Why are docs frequently neglected? (11:37)
  • Who should write the docs? (15:47)
  • How to ensure your docs are efficient (20:21)
  • When should you start writing your documentation? (24:32)


Links:

Brian

Tämä jakso on lisätty Podme-palveluun avoimen RSS-syötteen kautta eikä se ole Podmen omaa tuotantoa. Siksi jakso saattaa sisältää mainontaa.

Jaksot(279)

A Product Strategy Framework for Going from Closed to Open Source

A Product Strategy Framework for Going from Closed to Open Source

In this episode of The Business of Open Source, I spoke with Kris Zyp, SVP of engineering at HarperDB, in the third and final episode in the series about how Harper went from a closed-source company t...

18 Elo 31min

Giving your Users a Well-Lit Path with Matt Watson

Giving your Users a Well-Lit Path with Matt Watson

In today’s episode of The Business of Open Source, I spoke with Matt Watson, CEO of Fullscale, about a number of topics related to product development and how AI is changing that. Let’s start with a q...

10 Elo 34min

Interviewing your Target Customers to Accelerate Product-Market Fit

Interviewing your Target Customers to Accelerate Product-Market Fit

This week on The Business of Open Source, I talk with Julien Verlaguet, the CEO of Skiplabs. Julien is a programming language guy, and we talked about what it means to maintain an open source programm...

3 Elo 37min

Making AI an Opportunity with Joshua Drake

Making AI an Opportunity with Joshua Drake

In this episode of The Business of Open Source, I talked with Joshua Drake, president and CTO of Command Prompt, about business management, bootstrapping versus taking investment, and AI, open source ...

30 Heinä 40min

From Closed to Open: Shortening Sales Cycles with Stephen Goldberg

From Closed to Open: Shortening Sales Cycles with Stephen Goldberg

This week on The Business of Open Source, I chatted with Stephen Goldberg, co-founder of Harper, about the process of taking Harper from a closed-source software company to a open source company. I al...

6 Heinä 33min

Does AI Make Open Core Models More Difficult? with Sam Alba

Does AI Make Open Core Models More Difficult? with Sam Alba

Today on The Business of Open Source I spoke with Sam Alba, co-founder of Mendral, formerly of Dagger, and the first hire at Docker. We talked a lot about about how AI is changing the developer tools ...

2 Heinä 39min

Closed to Open Source Series: Doing Open Source "Right" with Ethan Arrowood

Closed to Open Source Series: Doing Open Source "Right" with Ethan Arrowood

One of the myths that swirl around the open source company ecosystem is that all open source companies started as an open source project that then suddenly got traction, and followed by the founders f...

22 Kesä 40min

The Value of Code is Dropping to Zero with Yann Lechelle

The Value of Code is Dropping to Zero with Yann Lechelle

In this episode of The Business of Open Source, I talked with Yann Lechelle, Executive President of :Probabl.Perhaps the most interesting part of the conversation was about whether or not there is a r...

15 Kesä 42min

Suosittua kategoriassa Liike-elämä ja talous

sijotuskasti
rss-rahapodi
psykopodiaa-podcast
vallattomat
mimmit-sijoittaa
ostan-asuntoja-podcast
lakicast
rss-rahamania
hyva-paha-johtaminen
rss-sami-miettinen-neuvottelija
sijoituskaverit
rss-avaimet-menestykseen
herrasmieshakkerit
leadcast
rss-matkalla-johtajaksi-saija-aikas-petra-eratuli-powered-by-kauppakamari
rss-hilden-kaira
rss-esiintymisklinikka
rss-paasipodi
rss-oivalluksia-rahasta-elamasta
rss-rentotapaus