Lessons about Documentation
The links, tools and tips our engineers and designers share with each other, one “today I learned” at a time.
- lessons shared
- 19
- people sharing
- 9
- database started in
- 2018










Tech Insights· medium.com
Why do product manager and developers ignore the design documentation? — “Documentation should be an integral part of a team’s life, not a “cemetery” where good ideas come to die.”
Shared by
Read on medium.com- Design
- Documentation
- Guidelines
- Pm
- UX

community.atlassian.com
Page status, a new way to keep your team informed!
Hi Confluence Community, Let’s talk about the fear of writing. For many, putting pen to paper is terrifying. Then having to share work with other people so that it can be critiqued or reviewed? CRINGE. If you’re like me, there's nothing worse than someone leaving feedback on a page before it’s ready. As a Product Manager,…
Thiago Paim

Tech Insights· community.atlassian.com
Page status, a new way to keep your team informed!
From community.atlassian.com
Hi Confluence Community, Let’s talk about the fear of writing. For many, putting pen to paper is terrifying. Then having to share work with other people so that it can be critiqued or reviewed? CRINGE. If you’re like me, there's nothing worse than someone leaving feedback on a page before it’s ready. As a Product Manager,…
Shared by
Read on community.atlassian.com- Confluence
- Documentation

quillbot.com
How to write better, faster & clearer with this artificial intelligence paraphrasing tool
Anna Erbetta

Tech Insights· quillbot.com
How to write better, faster & clearer with this artificial intelligence paraphrasing tool
Shared by
Read on quillbot.com- Documentation
- Writing
Today I learned
When dealing with extensive Figma files with dozens of different Pages, you can create an empty page between other pages and ...
When dealing with extensive Figma files with dozens of different Pages, you can create an empty page between other pages and call it ” ” to create breathing rooms between contexts and make the file more amicable to navigate.
Pedro Bacelar
Tech Insights
When dealing with extensive Figma files with dozens of different Pages, you can create an empty page between other pages and ...
When dealing with extensive Figma files with dozens of different Pages, you can create an empty page between other pages and call it ” ” to create breathing rooms between contexts and make the file more amicable to navigate.
Shared by
- Design
- Documentation
- Figma
- UI


Tech Insights· uxdesign.cc
A Guide to Successful Design Handoffs
Shared by
Read on uxdesign.cc- Design
- Documentation
- Handoff
- Qa
- Specs
- UI


Tech Insights· marmelab.com
A brief guide on updating your Makefile to become a self-documented tool, with a list of available commands alongside their short description
Shared by
Read on marmelab.com- Documentation
- Makefile
- Self Documenting Tools

perforce.com
How to Write a Product Requirements Document — With Examples
Learn five steps to writing a modern PRD with best practices, templates, and examples. Discover why PRDs matter in Agile environments and how to avoid common mistakes.
Pedro Bacelar

Tech Insights· perforce.com
How to Write a Product Requirements Document — With Examples
From perforce.com
Learn five steps to writing a modern PRD with best practices, templates, and examples. Discover why PRDs matter in Agile environments and how to avoid common mistakes.
Shared by
Read on perforce.com- Documentation
- Epic
- Process
- Product
- Requirements
- Roadmap

understandlegacycode.com
“You don’t need a validation stamp from the Tech Lead to update the doc. Anyone should feel entitled to do it.”
What you should be looking for to build a great and useful documentation.
Filipe Ximenes

Tech Insights· understandlegacycode.com
“You don’t need a validation stamp from the Tech Lead to update the doc. Anyone should feel entitled to do it.”
From understandlegacycode.com
What you should be looking for to build a great and useful documentation.
Shared by
Read on understandlegacycode.com- Documentation


Tech Insights· uxdesign.cc
Dig & Document: before you start designing
Shared by
Read on uxdesign.cc- Design
- Documentation
- Requirements



onepageonehour.com
a statement on why done is better than perfect with a way to work with constraints to force less-than-optimal deliveries
A pledge to reduce busywork, increase collaboration, and drive better outcomes.
Rob Novelino

Tech Insights· onepageonehour.com
a statement on why done is better than perfect with a way to work with constraints to force less-than-optimal deliveries
From onepageonehour.com
A pledge to reduce busywork, increase collaboration, and drive better outcomes.
Shared by
Read on onepageonehour.com- Documentation
- Management
- Process

plan.io
How to plan, write, and deliver technical documentation that works:
For as long as we’ve had tools we need help using (and language to talk to each other), we’ve had technical documentation. (Don’t believe me? The first example of technical writing in English dates back to the Middle Ages when Chaucer wrote a guide to the astrolabe—a device used for measuring...
Aline Silveira

Tech Insights· plan.io
How to plan, write, and deliver technical documentation that works:
From plan.io
For as long as we’ve had tools we need help using (and language to talk to each other), we’ve had technical documentation. (Don’t believe me? The first example of technical writing in English dates back to the Middle Ages when Chaucer wrote a guide to the astrolabe—a device used for measuring...
Shared by
Read on plan.io- Documentation
- Product
- Writing


Tech Insights· medium.com
Tips to design & write good design documentation, from the Dropbox team
Shared by
Read on medium.com- Design
- Documentation
- Workflow
- Writing

infoq.com
An interesting description of how Architecture Decision Records, aka ADR, are used at Spotify
Several teams at Spotify use architecture decision records (ADR) to capture decisions they make. ADRs have brought a number of benefits to Spotify, including improved onboarding for new developers, improved agility when handing over project ownership due to organization changes, and improved alignment across teams regarding best practices.
Carlos Coelho

Tech Insights· infoq.com
An interesting description of how Architecture Decision Records, aka ADR, are used at Spotify
From infoq.com
Several teams at Spotify use architecture decision records (ADR) to capture decisions they make. ADRs have brought a number of benefits to Spotify, including improved onboarding for new developers, improved agility when handing over project ownership due to organization changes, and improved alignment across teams regarding best practices.
Shared by
Read on infoq.com- Adr
- Agile
- Documentation
- Management


Tech Insights· divio.com
"There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four."
Shared by
Read on divio.com- Documentation
- Writing
Book a call
Found it useful?
Let’s put it to work
Tell us about your product and the problem in front of you. We’ll bring what we’ve learned on real projects.
Tell us about your product, and we’ll bring what we’ve learned.
Still prefer the good old email? Contact us



