Elizabeth Allan

In my years of working with writers, I've noticed that some (myself included!) tend to overthink revision, which can subsequently lead to what I call "over-editing." Newer writers can be especially susceptible to this, but it can affect any writer at any time. My writing tip for how to combat the inclination to "over-edit" was published today in Cleaver Magazine's "Writing Tips" section; you can read it here: https://lnkd.in/gxv_jnah. #writingtips #writers #editors #writingcoach

5

Many writers and editors think the Associated Press Stylebook is against using the serial (Oxford) comma. That’s not true. AP style *does* recommend using the serial comma in complex lists. For example, if one of the items in a list contains a conjunction, AP style calls for a serial comma. Like this: Fritz enjoys snacking on bananas, cheese and crackers, and ice cream. Additionally, if the items in the list are long, AP style calls for a serial comma. Like this: Helen changed the car’s worn tire before embarking on her big road trip, Raul shined the fenders until he could see his reflection in them, and Sara double-checked all fluid levels. AP does not recommend using a serial comma in a simple list: Dante bought strawberries, sliced turkey and rye bread. This is in contrast to most other style guides, including The Chicago Manual of Style, which calls for a serial comma in all lists. To learn more differences between AP style and Chicago style, check out Dragonfly Editorial’s field guide on this very topic. It’s titled “AP Style and Chicago Style: 15 Major Differences,” and the link is in the comments.

681

72 Comments

This is for Technical writers. Whenever you are documenting an AI-driven software system, start by creating flowcharts for each algorithm or process within the system. Next, learn how to develop comprehensive system behavior descriptions that detail how the system you are documenting adapts to new data inputs, handles errors, and evolves over time. Incorporate real-world scenarios to illustrate the system's responses so that users can anticipate and understand the system's behavior in various contexts. I'll give you an example: A customer makes a direct request to the chatbot, "Can I return a product if I’ve lost the receipt?" System's Response: "Our return policy allows for exchanges without a receipt, but refunds require proof of purchase. Would you like help initiating an exchange?" By combining algorithm flowcharts with detailed system behavior descriptions, you are to provide a clear, structured, and comprehensive understanding of the system, for usability and effective communication among stakeholders. #Linkedinlearn #technicalwriting #writer

3

1 Comment

Remember four years ago? We were in the midst of the pandemic; life was strange. One of the things I was struggling with four years ago was productivity, and I know I wasn't the only one! I'm re-sharing this blog post that I wrote at that time. If you're struggling with feeling "productive" (whatever that means to you), this is a good reminder. "There’s a tendency for people to assess their self-worth based on productivity. And while I think that everyone struggles with the coupling of these two concepts (self-worth and productivity) to some extent, writers (and other creative types) may be especially prone to evaluating their self-worth in this way." Read more: https://lnkd.in/eJY5_7Y #selfcare #writing #writers #writingcommunity #productivity #creativewriting

1

My newest article on my publishing Substack shows authors how to get a strong start at gathering reviews from your release team and through pro reviewing sites. https://lnkd.in/gF7dA_7r

4

Nobody likes to be bounced around for answers. Technical writers minimize escalations by ensuring the knowledge base is thorough and accurate, enabling AI to resolve issues on the first contact. Less back-and-forth means happier customers and more efficient service. 🎯 Technical Writers’ Role: They ensure that the knowledge base includes thorough and accurate information, which helps in resolving customer issues on the first contact. Impact on AI: AI systems equipped with well-grounded knowledge can achieve higher rates of first-contact resolution, reducing the need for escalations and improving overall service efficiency.

5

A quick reminder - if you want your writing to be more accessible, left-align the text! #LITranslators

9

4 Comments

Ideally, the copyedit is phase two in your editing journey. You’ve had your manuscript assessed and you’ve received feedback – whether this is from Beta readers or a professional editor who provides a detailed report – and you’ve gone on with The Big Rewrite. The Big Rewrite is draft two (or maybe for you it’s draft three, everyone’s process will be different). This draft is where you really shape your story. Any problems regarding character arc, sequence of events, plot, or consistent inconsistencies have been addressed and you’re working through them in this next stage. You’re making sure your writing is really singing how you want it to. Then, you hire a professional editor to give your work a copyedit. This is a line edit and it’s addressing: - Syntax and grammar - The writing at sentence level - The structure within chapters and scenes - How the writing itself informs the big picture of the story - Tone of voice and point of view - Formatting - Spelling and style It’s what I like to call the dirty work and it is absolutely crucial in taking your second draft to the next level. If your manuscript is ready for phase two, get in touch.

2

[NEW] Technical Writing Essential Toolkit "To craft clear, concise, and effective documentation, technical writers rely on a variety of specialized tools. This article explores these tools, with which every technical writer and IT professional should be familiar to enhance productivity, ensure accuracy, and deliver high-quality documentation." > 🎧 Listen now: https://lnkd.in/gZMeFMBY > Read now: https://lnkd.in/gtYYsFm2 #TechnicalWriting #documentation #IT

6

1 Comment

Got writer's block? Something every writer has to combat is excessive editing, or not editing enough. It’s often hard to edit and proofread a specific document or email, before giving it the go ahead. That’s where I step in. Editing documents is a challenging process requiring a keen eye for detail and a deep understanding of the material. A good editor has to be skilled because: 1. Subtle errors like typos, grammatical mistakes, and punctuation errors can easily be overlooked, even by your computer’s autocorrect feature. 2. They affect your document’s readability. A good editor can improve your content without altering your unique voice and style which is crucial for maintaining authenticity. Seeking an experienced editor for articles, memorandums, or other communication? Send me a message for a free consultation. ___________________________________________________ I'm Tracy, a business communications expert who has helped numerous clients refine their content to perfection. Let my extensive experience in editing help you create error-free, engaging, and professional content. Send me a DM to consult about my editing services. \#valiantresumes \#businesscommunication \#businesscommunications \#careercoaching

1

[NEW] Technical Writing Essential Toolkit "To craft clear, concise, and effective documentation, technical writers rely on a variety of specialized tools. This article explores these tools, with which every tech writer and IT pro should be familiar." > 🎧 Listen now: https://lnkd.in/gCUvn2Em > Read now: https://lnkd.in/gG9Cjq4y #TechnicalWriting #documentation

8

Understanding Evergreen Documents "Evergreen documentation, also known as living documents, does more than merely give tech writers like us the ability to update and fix problems in our content post-publication. It also creates an environment in which these documents and communications assets must be maintained." > 🎧 Listen now: https://shorturl.at/g13I9 > Read now: https://shorturl.at/4RkFq #TechnicalWriting #documentation #IT

1

It's #WorkInPublishing week! So I thought it was the best time to update and re-share my Publishing Hopeful's Toolkit: https://buff.ly/4e0DP6D A free resource for #PublishingHopefuls looking for advice and guidance on breaking into the publishing industry. 🚀 Whether you need help writing CVs, looking for tips on how to ace a job interview or tips on crafting an authentic and thumb-stopping cover letter, this toolkit should help you find an answer.

26

1 Comment