Revision
Revision is the process of reviewing and modifying existing work to correct deficiencies or improve its quality or suitability.
Writing for Developers: Blogs that get read
The process of reviewing, modifying, and improving a draft's content, structure, clarity, or correctness.
- How it is used
- Improves technical articles by aligning them with reader needs, strengthening important explanations, and preparing them for publication.
- How deep it goes
- Provides a staged revision procedure with read-aloud tests and prioritization, while de-emphasizing exhaustive grammar polishing and endless refactoring.
- Examples
- Uses timed drafting, out-of-order writing, read-aloud tests, grammar tools, AI prompts, second opinions, and internet checks.
- What you can do after
- Apply it via targeting criteria, read-aloud tests, timeboxes, grammar checkers, AI prompts, feedback, and final fact checks.
Read how Writing for Developers: Blogs that get read explains revision →
"Looks Good to Me"
Substantial modification of proposed software changes to address concerns about their implementation, scope, or correctness.
- How it is used
- Shortens prolonged pull-request review cycles by turning major rework into an explicit, collaborative clarification process.
- How deep it goes
- Explains causes, prevention, synchronous escalation, and review milestones, but does not specify implementation-level refactoring techniques.
- Examples
- Uses recurring pull-request rework, major reviewer revisions, unaddressed comments, offline conversations, and review milestones.
- What you can do after
- Apply direct reviewer-author conversations and earlier design clarification to reduce misunderstandings and repeated pull-request updates.
Related concepts
- behavior-driven developmentaddressed by · Behavior-driven development is a collaborative software practice that specifies and validates expected behavior through human-readable examples meaningful to technical and nontechnical stakeholders.
- feedbackused by · Feedback is information about an action, system, or outcome that can inform evaluation, decisions, or subsequent behavior.
- continuous improvementused by · Continuous improvement is an ongoing process of evaluating outcomes and making successive changes to improve a system, process, or result.
- product visionconfigured by · A product vision is a motivating description of a desired future product state, value, or experience that provides long-term direction.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.