
Docs for Developers
Sobre o livro
Getting Started
- Researching documentation
Understanding your users
Cultivating empathy
- Understanding user desires, user needs, and company needs
Recruiting users for research
Research methods
- Reading code comments
Trying it out
Running diverse and inclusive focus groups and interviews
User journey mapping
- Identifying and working with stakeholders
Finding your experts
Collaborative documentation development
- Learning from existing content
The value of design documents
Finding examples in industry
Friction logs
Defining your initial set of content
Deciding your minimum viable documentation
- Drafting test and acceptance criteria
Understanding content types
Concepts, tutorials and reference documentation
API specifications
READMEs
Guides
Release notes
Setting yourself up for writing success
Who is this for? Personas, requirements, content types
- Definition of done
How to iterate
Tools and tips for writing rough drafts
Understanding your needs
Choosing your writing tools (handwriting, text-only, productivity/measurement writing tools)
- "Hacks" to get started drafting content
Mechanics
Headings
Lists
Notes and warnings
Conclusions/tests
Using templates to form drafts
- Purpose of a template
How to derive a template from existing docs
How to take templates into text
Gathering initial feedback
Feedback methods
Getting feedback from difficult contributors
Editing content for publication
Determine destination
Editing tools (Grammarly, linters, etc)
- Declaring good enough
Recap, strategies, and reassurance
Structuring sets of documentation
Where content types live
Concepts, tutorials and reference documentation
- Code comments
API specifications
Guides
Release notes
READMEs
Content information architecture styles
Designing for search
- Creating clear, well-lit paths through content
User testing and maintenance
Planning for document automation
Integrating code samples
When and why to use code samples
- Creating concise, usable, maintainable samples
Standardising your samples
Using visual content: Screenshots, diagrams, and videos
- When your documentation may need visual content
Making your visual content accessible
Integrating screenshots, diagrams
- Videos
Measuring documentation success
How documentation succeeds
Structural Quality
Functional Quality
- Process Quality
Measuring what you want to change
Drawing conclusio
Ficha técnica
- Autor
- Jared, Bhatti, Jared Bhatti
- Editora
- UmLivro
- Formato
- BOOK
- Encadernação
- Capa comum
- ISBN
- 9781484272169
- EAN
- 9781484272169
- Ano de Publicação
- 2021
- Número de Páginas
- 252
- Dimensões
- 23.4 x 15.6 x 3 cm
- Peso
- 0.36 kg
- Idioma
- pt-BR
- Edição
- 1
- SKU
- 9781484272169





