dblock / dblock/code.dblock.org

Writing docs at Amazon, engagement model

Open
#122 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

post topic suggestion
Dominant language
JavaScript
Stars
7
Forks
30
PR merge metrics
No merged PRs in 30d

Description

Describe the engagement model to convince people to do anything through docs (at Amazon).

Credit for the question to H.K. for the question.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue body is the only stated entry point and does not name a documentation file, section, or test. First clarify the intended Amazon engagement model and where it should be documented; it is done when the model is written down with enough context to motivate readers to engage through documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.