The Product is Docs: Writing technical documentation in a product development group
Thumbnail 1Thumbnail 2

The Product is Docs: Writing technical documentation in a product development group

4.5/5
Product ID: 557000412
Secure Transaction
12 interest-free installments with tabby
Frequently Bought Together

Description

Full description not available

Reviews

4.5

All from verified purchases

S**Z

Nice read. Formatting could have been better.

This is really a good book. I read it on Kindle. May be that is why I have the formatting comment. Besides that, I'd also love to see summary of key points in each chapter - say at the end. Technical writing templates would add to usefulness of this book. For example in Technical Editing chapter, I'd have loved to see some examples or links to GitHub projects that have 'awesome' technical writing - that would be really useful for new, first time, non-experienced writers (read SW developers).

P**D

Even this old-timer learned from this book

I've been a technical writer or technical editor for decades. But not until 2020 did I serve on an Agile development team. I should have read this book in 2020! I thought I was doing all I could to help my readers and my team. I wasn't ... but soon I will.I read eight to twelve books on writing each year. But most deal with the art of crafting sentences a paragraphs. Thanks to this book, I plan to read more books devoted to the tech writing as a process.Let me add that the Splunk book ranks as one of the best-written, best-edited writing books I've had the pleasure to read. Try as I might, I couldn't find more than five or six nits to pick. Most were about concordance of grammatical person. The Introduction begins, "In the course of doing our work, the Splunk documentation team strives to adopt—and adapt—industry best practices whenever we can find them." "Our work" promises that the main subject will be the first person "we." Nope: It's the third person "the ... team." Then it's back to "we" in "whenever we can find them." But again, I see this practice everywhere. In 10 years, no one will understand why people like me ever cared.

R**N

Real-world, practical advice about technical documentation

I just finished this book. It's excellent. I work in the technical documentation field. It struck me as more practical and real-world based than the way technical documentation is often presented elsewhere. When you're in the weeds, the day-to-day of software creation and its documentation, rigid processes tend to break, complex processes tend to break down, and sometimes what seemed like simplification of the overall process turns out to slow it down or reduce quality.

Common Questions

Trustpilot

TrustScore 4.5 | 7,300+ reviews

Ayesha M.

The product exactly matches the description. Very satisfied with my purchase.

5 days ago

Vikram D.

The MOLLE sheath is of exceptional quality. Very happy with my purchase.

2 weeks ago

Shop Global, Save with Desertcart
Value for Money
Competitive prices on a vast range of products
Shop Globally
Serving over 300 million shoppers across more than 200 countries
Enhanced Protection
Trusted payment options loved by worldwide shoppers
Customer Assurance
Trusted payment options loved by worldwide shoppers.
Desertcart App
Shop on the go, anytime, anywhere.
SAR 251

Duties & taxes incl.

KSAstore
1
Free Returns

30 daysfor PRO membership users

15 dayswithout membership

Secure Transaction
12 interest-free installments with tabby

Trustpilot

TrustScore 4.5 | 7,300+ reviews

Ali H.

Fast shipping and excellent packaging. The Leatherman tool feels very premium and sturdy.

1 day ago

Pooja R.

The customer service exceeded my expectations. Perfect for buying products you can't find elsewhere.

1 week ago

The Product Is Docs Writing Technical Documentation In A Product | Desertcart KSA