Writing Guidelines

When writing for Spring Framework Guru, please follow these guidelines:

• All writing should be done in American style English (and spelling)
• Ideal article length is 1500 words. Of course, simple 'how-to' articles may be shorter.
• Use a conversational tone. Pretend you are talking to a friend. Avoid sterile corporate type writing. (Boring!)
• Use short concise sentences and paragraphs. Make it easy to read and skim over.
• Paragraphs should be no longer than 3 sentences.
• It's okay to use a short single sentence paragraph to give the readers a visual break.
• Use an introduction and summary. Tell them what you are going to tell them, tell them, and then tell them what you told them.
• Break up the content. Use heading levels, bulleted lists, and sample code blocks.
• Focus on helping the reader. You are guiding them on a clear journey.
• Be inclusive. Prefer using 'we' over 'you' or 'I'.
• Be gender neutral. Use 'they' or 'them' over 'he' or 'she'.
• Checkout Grammarly if you are not a native English speaker.
• Boomerang for Gmail is another great tool. Respondable will rate the friendliness of your writing.
• Target a Flecsh Reading Ease score of 60-70.
• Do not copy or plagiarize content from other websites or publications.
• Any graphics should be of professional quality. (See draw.io for a great free online tool!)
• Any IDE screenshots should be of IntelliJ. (Dark theme preferred)
• Links should open in a new tab.
• Be familiar with other content on SFG, and link to it as appropriate.