homepage
Open menu Go one level top
  • Train and Certify
    • Get Started in Cyber
    • Courses & Certifications
    • Training Roadmap
    • Search For Training
    • Online Training
    • OnDemand
    • Live Training
    • Summits
    • Cyber Ranges
    • College Degrees & Certificates
    • NICE Framework
    • DoDD 8140
    • Specials
  • Manage Your Team
    • Overview
    • Security Awareness Training
    • Voucher Program
    • Private Training
    • Workforce Development
    • Skill Assessments
    • Hiring Opportunities
  • Resources
    • Overview
    • Reading Room
    • Webcasts
    • Newsletters
    • Blog
    • Tip of The Day
    • Posters
    • Top 25 Programming Errors
    • The Critical Security Controls
    • Security Policy Project
    • Critical Vulnerability Recaps
    • Affiliate Directory
  • Focus Areas
    • Blue Team Operations
    • Cloud Security
    • Digital Forensics & Incident Response
    • Industrial Control Systems
    • Leadership
    • Offensive Operations
  • Get Involved
    • Overview
    • SANS Community
    • CyberTalent
    • Work Study
    • Instructor Development
    • Sponsorship Opportunities
    • COINS
  • About
    • About SANS
    • Why SANS?
    • Instructors
    • Cybersecurity Innovation Awards
    • Contact
    • Frequently Asked Questions
    • Customer Reviews
    • Press Room
  • Log In
  • Join
  • Contact Us
  • SANS Sites
    • GIAC Security Certifications
    • Internet Storm Center
    • SANS Technology Institute
    • Security Awareness Training
  • Search
  1. Home >
  2. Blog >
  3. Writing Tips for IT Professionals
370x370_Lenny-Zeltser.jpg
Lenny Zeltser

Writing Tips for IT Professionals

January 25, 2019

Writing_Tips_for_IT_Professionals.png

This cheat sheet offers guidelines for IT professionals seeking to improve technical writing skills. To print it, use the one-page PDF version; you can also customize the Word version of the document.

Lenny Zeltser, the creator of this cheat sheet, is the author of SEC402: Cybersecurity Writing: Hack the Reader. Click the link to learn more about the course.

General Recommendations

  • Determine your writing objectives.
  • Understand what your readers want to see in your text and how they want to see it.
  • Keep your message or document as short and simple as possible to achieve the goals of both parties.
  • Use terminology and tone appropriate for the audience.
  • Craft your text with the understanding that some readers will merely skim it.
  • Enable spelling and grammar-checking tools.
  • Don't plagiarize. Err on the side of caution. When in doubt, attribute anyway.
  • Carefully read your text before finalizing it.
  • Seek others' feedback on the structure, look, words, and content of your writing.
  • Improve your writing skills through deliberate efforts.
  • Recognize that these tips are just guidelines. There are always exceptions.

Advice for Writing Sentences

  • Delete words whose absence doesn't significantly deter from the meaning of the sentence.
  • Keep your sentences short.
  • Be consistent regarding the Oxford comma.
  • Avoid passive voice, which often leads to ambiguity and confusion.
  • When feeling the need to use a semicolon, parenthesis or an em dash, consider breaking the thought into separate sentences.
  • Maintain structural and stylistic parallelism across your headings and list elements.
  • Know the difference between such as and like and use them accordingly.

Advice for Writing Paragraphs

  • Place your most important point in the beginning of the paragraph.
  • Split long paragraphs into several short ones for easier reading and skimming.
  • Avoid one-sentence paragraphs unless you want to place spotlight on the paragraph.
  • Delete paragraphs that don't significantly contribute to the flow or meaning of your text.
  • Make sure the sentences in the paragraph support the paragraph's objective.

Tips for Email Messages

  • Try to keep your message shorter than 3 paragraphs.
  • Lead with the strongest statement to grab attention.
  • Assume the recipient will read only the first 2 sentences.
  • Use the Subject line to get your main point across.
  • Keep the message personally-relevant to the reader.
  • Don't respond in the heat of the moment. Take time to reflect.
  • Be specific about what action you'd like the reader to take or which conclusion the reader should reach.
  • Consider whether email is the best medium for your message.

Tips for Longer Reports

  • Use a consistent, generally-accepted style for capitalizing words in a title.
  • Pick a title that'll catch the reader's attention while also setting their expectations.
  • Create a strong executive summary that stands on its own even if the reader ignores the rest of the report.
  • Split the report into multiple sections to logically group and separate contents.
  • Strive for a simple structure, avoiding deep nesting of headings and lists.
  • Include at least one paragraph between two headings for an introduction or transition.
  • Use the word processor's style management features for consistent formatting of headings and other text.
  • Craft captions that guide readers to the conclusions you want them to reach about the chart or figure.
  • Place lengthy technical excerpts such as large code fragments into an appendix.
  • Refer to every figure and appendix section from your main text.
  • Make sure the headers and footers include the right notices (copyright, confidential, page number, etc.).

Formatting Guidelines

  • Err on the side of simplicity when selecting a visual style for your document or message.
  • Use italics or boldface, not both, when emphasizing.
  • Know the difference between em dashes and hyphens, and use them accordingly.
  • Avoid breaking short lists or paragraphs across pages.
  • Insert a single space, not 2, between sentences.
  • Keep font size and typeface consistent throughout your report.
  • Avoid unnecessary capitalization.
  • Crop and size screenshots to ensure readability.

Tips for Text Chats

  • Skip the period at the end of your message if you want.
  • Use emoticons to add non-verbal clues that might exist in a verbal chat.
  • Avoid emoticons and abbreviations that the recipient might not understand.
  • Watch out for the errors introduced by autocorrect.
Share:
TwitterLinkedInFacebook
Copy url Url was copied to clipboard
Subscribe to SANS Newsletters
Join the SANS Community to receive the latest curated cybersecurity news, vulnerabilities, and mitigations, training opportunities, plus our webcast schedule.
United States
Canada
United Kingdom
Spain
Belgium
Denmark
Norway
Netherlands
Australia
India
Japan
Singapore
Afghanistan
Aland Islands
Albania
Algeria
American Samoa
Andorra
Angola
Anguilla
Antarctica
Antigua and Barbuda
Argentina
Armenia
Aruba
Austria
Azerbaijan
Bahamas
Bahrain
Bangladesh
Barbados
Belarus
Belize
Benin
Bermuda
Bhutan
Bolivia
Bonaire, Sint Eustatius, and Saba
Bosnia And Herzegovina
Botswana
Bouvet Island
Brazil
British Indian Ocean Territory
Brunei Darussalam
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Cape Verde
Cayman Islands
Central African Republic
Chad
Chile
China
Christmas Island
Cocos (Keeling) Islands
Colombia
Comoros
Cook Islands
Costa Rica
Croatia (Local Name: Hrvatska)
Curacao
Cyprus
Czech Republic
Democratic Republic of the Congo
Djibouti
Dominica
Dominican Republic
East Timor
East Timor
Ecuador
Egypt
El Salvador
Equatorial Guinea
Eritrea
Estonia
Ethiopia
Falkland Islands (Malvinas)
Faroe Islands
Fiji
Finland
France
French Guiana
French Polynesia
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Guinea-Bissau
Guyana
Haiti
Heard And McDonald Islands
Honduras
Hong Kong
Hungary
Iceland
Indonesia
Iraq
Ireland
Isle of Man
Israel
Italy
Jamaica
Jersey
Jordan
Kazakhstan
Kenya
Kingdom of Saudi Arabia
Kiribati
Korea, Republic Of
Kosovo
Kuwait
Kyrgyzstan
Lao People's Democratic Republic
Latvia
Lebanon
Lesotho
Liberia
Liechtenstein
Lithuania
Luxembourg
Macau
Macedonia
Madagascar
Malawi
Malaysia
Maldives
Mali
Malta
Marshall Islands
Martinique
Mauritania
Mauritius
Mayotte
Mexico
Micronesia, Federated States Of
Moldova, Republic Of
Monaco
Mongolia
Montenegro
Montserrat
Morocco
Mozambique
Myanmar
Namibia
Nauru
Nepal
Netherlands Antilles
New Caledonia
New Zealand
Nicaragua
Niger
Nigeria
Niue
Norfolk Island
Northern Mariana Islands
Oman
Pakistan
Palau
Palestine
Panama
Papua New Guinea
Paraguay
Peru
Philippines
Pitcairn
Poland
Portugal
Puerto Rico
Qatar
Reunion
Romania
Russian Federation
Rwanda
Saint Bartholemy
Saint Kitts And Nevis
Saint Lucia
Saint Martin
Saint Vincent And The Grenadines
Samoa
San Marino
Sao Tome And Principe
Senegal
Serbia
Seychelles
Sierra Leone
Sint Maarten
Slovakia (Slovak Republic)
Slovenia
Solomon Islands
South Africa
South Georgia and the South Sandwich Islands
South Sudan
Sri Lanka
St. Helena
St. Pierre And Miquelon
Suriname
Svalbard And Jan Mayen Islands
Swaziland
Sweden
Switzerland
Taiwan
Tajikistan
Tanzania
Thailand
Togo
Tokelau
Tonga
Trinidad And Tobago
Tunisia
Turkey
Turkmenistan
Turks And Caicos Islands
Tuvalu
Uganda
Ukraine
United Arab Emirates
United States Minor Outlying Islands
Uruguay
Uzbekistan
Vanuatu
Vatican City
Venezuela
Vietnam
Virgin Islands (British)
Virgin Islands (U.S.)
Wallis And Futuna Islands
Western Sahara
Yemen
Yugoslavia
Zambia
Zimbabwe

Tags:
  • Cyber Defense Essentials
  • Cybersecurity Insights

Related Content

Blog
Tech_Tuesday_Workshop_v2.jpg
Cybersecurity Insights
January 20, 2021
Experience SANS Live Online with Tech Tuesday Workshops
SANS is launching a new series of free Live Online Workshops, held every other Tuesday at 1:00pm ET.
SANS Institute
read more
Blog
Newsbites.jpg
Cybersecurity Insights
January 19, 2021
NewsBites Drilldown for the Week Ending 15 January 2021
John Pescatore - SANS Director of Emerging Security TrendsDriving IT Operations to Move to Essential Security Practices Needs to Be Job 1 This week's Drilldown will focus on two items (included below) from NewsBites Issue 4, which discusses related issues: a DHS CISA report that points out that...
370x370_john-pescatore.jpg
John Pescatore
read more
Blog
Digital Forensics and Incident Response, Cyber Defense Essentials
August 25, 2010
Intro to Report Writing for Digital Forensics
So you've just completed your forensic examination and found that forensic gem or smoking gun in your case, so how do you proceed? Depending on where you fall as a forensicator (e.g., law enforcement, intelligence, criminal defense work, incident response, e-discovery) you will have to report your...
Brad Garnett
read more
  • Register to Learn
  • Courses
  • Certifications
  • Degree Programs
  • Cyber Ranges
  • Job Tools
  • Security Policy Project
  • Posters
  • The Critical Security Controls
  • Focus Areas
  • Blue Team Operations
  • Cloud Security
  • Cybersecurity Leadership
  • Digital Forensics
  • Industrial Control Systems
  • Offensive Operations
Subscribe to SANS Newsletters
Join the SANS Community to receive the latest curated cybersecurity news, vulnerabilities, and mitigations, training opportunities, plus our webcast schedule.
United States
Canada
United Kingdom
Spain
Belgium
Denmark
Norway
Netherlands
Australia
India
Japan
Singapore
Afghanistan
Aland Islands
Albania
Algeria
American Samoa
Andorra
Angola
Anguilla
Antarctica
Antigua and Barbuda
Argentina
Armenia
Aruba
Austria
Azerbaijan
Bahamas
Bahrain
Bangladesh
Barbados
Belarus
Belize
Benin
Bermuda
Bhutan
Bolivia
Bonaire, Sint Eustatius, and Saba
Bosnia And Herzegovina
Botswana
Bouvet Island
Brazil
British Indian Ocean Territory
Brunei Darussalam
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Cape Verde
Cayman Islands
Central African Republic
Chad
Chile
China
Christmas Island
Cocos (Keeling) Islands
Colombia
Comoros
Cook Islands
Costa Rica
Croatia (Local Name: Hrvatska)
Curacao
Cyprus
Czech Republic
Democratic Republic of the Congo
Djibouti
Dominica
Dominican Republic
East Timor
East Timor
Ecuador
Egypt
El Salvador
Equatorial Guinea
Eritrea
Estonia
Ethiopia
Falkland Islands (Malvinas)
Faroe Islands
Fiji
Finland
France
French Guiana
French Polynesia
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Guinea-Bissau
Guyana
Haiti
Heard And McDonald Islands
Honduras
Hong Kong
Hungary
Iceland
Indonesia
Iraq
Ireland
Isle of Man
Israel
Italy
Jamaica
Jersey
Jordan
Kazakhstan
Kenya
Kingdom of Saudi Arabia
Kiribati
Korea, Republic Of
Kosovo
Kuwait
Kyrgyzstan
Lao People's Democratic Republic
Latvia
Lebanon
Lesotho
Liberia
Liechtenstein
Lithuania
Luxembourg
Macau
Macedonia
Madagascar
Malawi
Malaysia
Maldives
Mali
Malta
Marshall Islands
Martinique
Mauritania
Mauritius
Mayotte
Mexico
Micronesia, Federated States Of
Moldova, Republic Of
Monaco
Mongolia
Montenegro
Montserrat
Morocco
Mozambique
Myanmar
Namibia
Nauru
Nepal
Netherlands Antilles
New Caledonia
New Zealand
Nicaragua
Niger
Nigeria
Niue
Norfolk Island
Northern Mariana Islands
Oman
Pakistan
Palau
Palestine
Panama
Papua New Guinea
Paraguay
Peru
Philippines
Pitcairn
Poland
Portugal
Puerto Rico
Qatar
Reunion
Romania
Russian Federation
Rwanda
Saint Bartholemy
Saint Kitts And Nevis
Saint Lucia
Saint Martin
Saint Vincent And The Grenadines
Samoa
San Marino
Sao Tome And Principe
Senegal
Serbia
Seychelles
Sierra Leone
Sint Maarten
Slovakia (Slovak Republic)
Slovenia
Solomon Islands
South Africa
South Georgia and the South Sandwich Islands
South Sudan
Sri Lanka
St. Helena
St. Pierre And Miquelon
Suriname
Svalbard And Jan Mayen Islands
Swaziland
Sweden
Switzerland
Taiwan
Tajikistan
Tanzania
Thailand
Togo
Tokelau
Tonga
Trinidad And Tobago
Tunisia
Turkey
Turkmenistan
Turks And Caicos Islands
Tuvalu
Uganda
Ukraine
United Arab Emirates
United States Minor Outlying Islands
Uruguay
Uzbekistan
Vanuatu
Vatican City
Venezuela
Vietnam
Virgin Islands (British)
Virgin Islands (U.S.)
Wallis And Futuna Islands
Western Sahara
Yemen
Yugoslavia
Zambia
Zimbabwe
  • © 2021 SANS™ Institute
  • Privacy Policy
  • Contact
  • Twitter
  • Facebook
  • Youtube
  • LinkedIn