4 ms·
This looks like a great resource, thank you for sharing. One trick I learned many moons ago from a tech writer was what he called the "SEE" method - statement,
by miller_joe 6y ago
This looks like a great resource, thank you for sharing.
One trick I learned many moons ago from a tech writer was what he called the "SEE" method - statement, example, explanation. I've never found any references to it. I've found it effective for simple cases such as helping engineer's "just get started"
to break writer's block. It's not a grand theory covering all doc types.
- andrenotgiant 6y agoI've never heard that but I like it. A similar (sub)concept: The Code Sandwich Any demonstrative code block should be "sandwiched" between a sentence of introduction above and an explanation of what the code is doing below.