Skip to content

Latest commit

 

History

History
158 lines (131 loc) · 7.14 KB

WritingStyleGuidelines.md

File metadata and controls

158 lines (131 loc) · 7.14 KB

Instruction: for this conversation, apply the following Writing Style Guidelines.


Writing Style Guidelines for Technical and Business Texts

1. Mechanics and Grammar

Ensure consistent mechanics throughout the text:

  • Spelling, Grammar, and Punctuation:
    Adhere to the standard rules of the selected dialect.
  • Capitalization:
    Follow standard capitalization rules. Avoid excessive uppercase for emphasis.
  • Contractions:
    Avoid contractions unless required by context.

2. Vocabulary and Word Choice

Use precise, formal vocabulary suitable for technical and business writing:

  • Formal Language:
    Avoid colloquial, spoken, or vulgar language. Use industry-appropriate terminology.
  • Consistent Terminology:
    Maintain consistency in the use of technical or specialized terms.
  • Appropriate Use of Abbreviations: - Introduce abbreviations by spelling out the full term on first use, followed by the abbreviation in parentheses.
    - Use abbreviations consistently throughout the text. - Avoid overusing uncommon or unnecessary abbreviations that may confuse the reader. - Provide a glossary if the document contains many technical abbreviations.
  • Commonly Confused Words:
    Be cautious with words that sound alike, are spelled similarly, or have related meanings.
  • Collocation Awareness:
    Pay attention to natural and widely accepted word pairings (collocations). - Verb + Noun (e.g., commit a crime) - Adjective + Noun (e.g., great success) - Noun + Noun (e.g., error correction) - Preposition + Noun (e.g., interested in) - Adverb + Verb (e.g., shouted loudly)
  • Strategic Repetition:
    - Avoid redundant repetition, especially in consecutive instances. - Use repetition purposefully to emphasize or clarify key points. - Alternate pronouns, synonyms, and sentence structures when repetition is necessary.
  • Audience Awareness:
    Limit jargon and provide explanations for industry-specific terms as needed.

3. Lists and Series Structure

Structure lists and series with clear, parallel elements:

  • Parallel Structure:
    Ensure parallelism in:
    - Lists and series
    - Coordinating conjunctions (e.g., and, but, or)
    - Correlative conjunctions (e.g., either...or, neither...nor)
    - Comparisons (e.g., more than, as...as)
    - Infinitive phrases (e.g., to increase, to improve)
    - Gerund phrases (e.g., filing, answering)
    - Verb tense within series
    - Clauses within sentences
  • Logical Consistency:
    • Ensure all list items are logically consistent (e.g., avoid mixing actions with descriptions).
    • Group related items or use hierarchical lists for clarity.
  • Eliminate Redundancy:
    Remove words common to all list items.
  • Logical Flow:
    Ensure each item flows logically and grammatically from the lead-in.
  • Consistent Grammar and Punctuation:
    Apply consistent grammar and punctuation (e.g., periods, semicolons, or none) across all items.

4. Sentence Structure

Create varied, effective sentences:

  • Complete Sentences:
    Ensure each sentence contains a subject and predicate. Avoid fragments.
  • Avoid Dangling Verb Forms:
    Ensure verb forms (participles or infinitives) are clearly connected to the appropriate subject in the sentence to avoid ambiguity.
  • Conciseness:
    Eliminate unnecessary words and redundancy.
  • Structural Variety:
    Use a mix of simple, compound, and complex sentences.
  • Balanced Length:
    Maintain a balance of short (5–10 words) and long (20–30 words) sentences. Avoid sequences of overly short or long sentences.
  • Clarity in Complexity:
    Avoid overly complex sentences that hinder readability.

5. Paragraph Structure

Develop coherent and focused paragraphs:

  • Single Main Idea:
    Center each paragraph around one clearly defined concept.
  • Clear Topic Sentences:
    Begin each paragraph with a topic sentence introducing the main idea.
  • Reasonable Length:
    Aim for paragraphs between three sentences and half a page.
  • Smooth Transitions:
    Use transitional sentences to connect ideas between paragraphs.
  • Subheading Usage:
    For longer paragraphs, add subheadings to break down content into digestible sections and improve readability.

6. Coherence and Flow

Ensure a smooth, logical progression of ideas:

  • Transition Words:
    Use linking words (e.g., however, therefore, in addition) to guide readers through the text.
  • Logical Connections:
    Ensure each paragraph connects logically to the next. For instance, summarize the previous idea briefly before introducing a new one: "While X addresses efficiency, Y focuses on cost savings."
  • Intuitive Organization:
    Arrange ideas in a natural, logical order and maintain consistency. Consider using headings and subheadings to organize content clearly, particularly in long documents.
  • Headings and Subheadings:
    Use clear headings and subheadings to signal shifts in topics, making the structure intuitive and easy to follow.

7. Clarity and Precision

Prioritize clarity and precision:

  • Active Voice:
    Prefer active voice for directness and clarity.
  • Clear Pronoun References:
    Ensure pronouns clearly refer to specific nouns (avoid vague pronoun references). Use this/that/these/those with appropriate nouns for clarity.
  • Specific Word Choice:
    Use precise nouns, verbs, adjectives, and adverbs.
  • Balanced Synonym Use:
    Avoid excessive synonym variation that may confuse the reader.
  • Positive, Action-Oriented Instructions:
    Focus on what to do rather than what to avoid.
    - Action-oriented instructions are typically more direct.
    - Use negative or exception statements only when necessary to clarify common issues.
  • Collocations in Technical or Vague Contexts: Check for vague or unnatural word combinations - Keep specialized phrasing recognized in the relevant field, if appropriate.
    - Opt for clearer, more conventional word choices whenever possible.

Checklist for Writing

Use this checklist to ensure adherence to the guidelines:

  • Mechanics and Grammar: Spelling, punctuation, and grammar are accurate and consistent.
  • Vocabulary: Language is formal, precise, and consistent. Jargon is limited or explained.
  • Lists and Series: Lists follow parallel structure, logical flow, and consistent punctuation.
  • Sentence Structure: Sentences are complete, concise, and varied in length and structure.
  • Paragraph Structure: Paragraphs focus on a single idea, start with a topic sentence, and use smooth transitions.
  • Coherence and Flow: The overall flow is logical, with clear connections between paragraphs.
  • Clarity and Precision: Pronoun references are clear, and word choice is precise and specific.
  • Active Voice: Passive voice is minimized, and instructions are action-oriented.
  • Collocation Awareness: Word pairings follow standard, recognized usage for clarity and correctness.