Documents tell us before we write documents, we must state our purpose. Who should read those documents, don’t waste the reader’s time.
Punctuation tells us that we need to choose the right sign. if two sentences have a connection, we should use semicolons; if the connection is a sequence, we should use commas; if the second sentence is used to emphasize the first sentence - em-dashes; if the second sentence is minor points (parentheses).
Documents
- State your document’s scope
- State your audience
- Establish your key points upfront
- Write for your audience
- Organize
This document does not describe the design for the related technology, Project Froobus.
This document assumes that you understand matrix multiplication and how to brew a really good cup of tea.
You must read “Project Froobus: A New Hope” before reading this document.
Your document should contain:
- Who is your target audience?
- What do your readers already know before they’ve read the document?
- What should your readers know or be able to do after they’ve read your document?
Punctuation (optional)
- Commas , : Paste together two dependent thoughts.
- Semicolons ; : Unites highly related thoughts.
- Em-Dashes - : Encode structured data in an efficient yet extensible format.
- Parentheses () : Hold minor points and digressions.
This series of articles is extracted from Google Technical Writing Courses.
如果你覺得這篇文章很棒,請你不吝點讚 (゚∀゚)