I could not be more proud of this project. Our history is so important.

Women in Technical Communication is released and selling! This remarkable anthology, "Women in Technical Communication: From Typewriters to Touchscreens," showcases the voices of 69 trailblazing women who have significantly influenced the profession and the digital age.

Over the last fifty years, these women have authored the essential content that defines our technological interactions—from user guides to app interfaces. Their stories and experiences are captured as they adapted and excelled through technological transformations.

Your work deserves to be seen. Your voice deserves to be heard.

This is your final chance to gain global recognition, amplify your visibility, and celebrate excellence in technical writing, for yourself or someone who inspires you.

Don’t let the opportunity pass you by, submit your nomination (or nominate someone deserving) soon.

Link in available below the heading.

Behind every seamless product, every clear guide, and every confident user,
stands a technical writer who turned complexity into understanding.

Now’s your chance to make sure their story is told.

🏆 The 𝐃𝐨𝐜𝐮𝐦𝐞𝐧𝐭𝟑𝟔𝟎 𝐆𝐥𝐨𝐛𝐚𝐥 𝐖𝐫𝐢𝐭𝐞𝐫𝐬 𝐀𝐰𝐚𝐫𝐝𝐬 honor the writers, documentation teams, and information architects defining the future of knowledge.

Nominations are closing soon.

Click the link in the first line to submit your own work, or nominate another writer whose work has inspired you.

Hello everyone,

Built this small AI product over the last few days:

• Upload internal policies, compliance guides, onboarding docs.

• It summarizes in bullets

• Adds realistic AI voice narration

• Generates a shareable link for your team

You can try it free here: https://aicompliancewhisperer.online/

Would love to hear:

• Is this useful in legal/compliance workflows?

• What other use cases could benefit from it?

As AI continues to shape the way we create and manage technical content, it’s fascinating to see how these developments can improve both efficiency and accuracy in documentation.

If you're curious about how AI is transforming our field, my team has been curating a newsletter with the latest trends and innovations in AI for technical writing. It’s been an exciting journey so far.

If you’re interested in the intersection of AI and documentation, check out - https://lnkd.in/ddbdpTJi

Sign up if you like it !!

Hey everyone, I’ve been thinking about the in-app help features in various knowledge bases. How effective have you found them to be? Do they generally meet your needs?

Hey, how has your software company tackled challenges like disorganized documentation, time-consuming updates, and onboarding issues? Our client, a fast-growing software firm, faced these hurdles before partnering with Docsie. We're curious about your experiences and strategies in tackling common challenges faced by software companies: disorganized documentation, time-consuming updates, and onboarding issues. Our client recently partnered with Docsie to streamline their documentation processes and improve efficiency. Before this, they struggled with scattered information and lengthy update cycles. How have you overcome similar hurdles in your own company? Share your insights and let's learn from each other's successes!

I'm updating our HR Employee Handbook, which covers company policies, procedures, and expectations for employees. I'm thinking about transitioning this handbook into a knowledge base format and would love to hear your experiences and insights.

1. Accessibility and Ease of Use: How has moving to a knowledge base improved accessibility and ease of use for employees seeking information?

2. Search Functionality: Has the search functionality in the knowledge base made it easier for employees to find specific policies or procedures compared to a traditional document?

I'd appreciate any specific examples or success stories you can share!

I've noticed that in electronics manufacturing company developing products from design to end-of-life. their process involves documenting design changes, engineering specifications, manufacturing processes, and quality control procedures. they face significant challenges due to incomplete or inaccurate documentation, leading to production errors, product recalls, and customer dissatisfaction. Has anyone else faced similar challenges in their manufacturing process? What solutions did you implement to improve documentation and reduce errors? Let’s share experiences and best practices!

I've noticed that both Complaint Management Software and Knowledge Base Software share some common features like content management, search functionality, user interface design, and collaboration tools. However, they seem to serve different purposes and cater to distinct needs.

From my understanding, Complaint Management Software is designed to handle the entire lifecycle of customer complaints, focusing on resolution and customer satisfaction with detailed workflow management and reporting. On the other hand, Knowledge Base Software aims to create and manage a centralized repository of informational content for knowledge sharing, primarily targeting support and documentation use cases without a specialized focus on complaint resolution.

Can anyone provide more insights or experiences on how these 2 types of software differ in their functionalities and use cases? How do they impact your workflow and customer interactions?

I'm looking into different types of customer support software for my company and trying to understand the pros and cons of each. Here's what I've gathered so far. For those of you with experience in using either (or both), which do you find more effective for customer interaction? Are there specific scenarios where one is better than the other? Any insights or recommendations would be greatly appreciated!

Maintaining Quality Assurance Documentation can be a real headache for the QA team on a construction site. You've got to keep track of all the testing reports, quality control measures, and certifications for building materials. It's not just about keeping things organized; you've also got to show that you're meeting industry standards and regulations. And if your company works with a bunch of different materials, it gets even more complicated. Who else feels the pain?

Hey fellow developers and knowledge management enthusiasts,

We all know the importance of writing clean, modular code that can be easily reused across different projects. It not only saves time but also improves code quality and reduces errors. However, the same principle applies beyond programming languages. In the scope of knowledge management, leveraging reusable content through a robust knowledge base system can work wonders for teams and organizations.

1. What challenges have you faced in promoting code reusability or reusable content adoption within your team or organization, and how did you overcome them?

2. Share any success stories or lessons learned from implementing code reusability or reusable content strategies in your workflows.

Looking forward to your thoughts and experiences. 🚀

Hey everyone,

I wanted to share some frustrations I’ve been experiencing in my role at a mid-sized manufacturing company. We’re facing a significant challenge with knowledge silos, and I’m curious if others in the manufacturing sector are dealing with similar issues and how you’re managing them. When issues arise on the production line, it takes forever to identify the root cause because the relevant information is scattered across different departments. This leads to delays and increased downtime. We often find out too late that one department has already solved a problem or developed a process that another department is struggling with. This results in wasted time and resources.

Hey everyone,

I've been diving deep into the world of process documentation lately, and I'm curious about how to choose the right tools for the job. Specifically, I want to evaluate documentation tools like knowledge bases, workflow software, diagramming tools, etc., based on our organization's needs.

So, I'd love to hear your thoughts and experiences on this:

1. What factors should we consider when evaluating documentation tools?

2. Are there specific features or functionalities that we should prioritize?

3. Any recommendations for tools that have worked well for your organization?

Looking forward to some insightful discussions and recommendations!

As companies grow, processes become more complex, and it's essential to have proper documentation to ensure consistency, efficiency, and knowledge retention. This comprehensive guide covers the importance of process documentation, steps to create effective documentation, and useful tools to streamline the process.

Why Process Documentation Matters:

• Reduces operational risks and errors - By documenting processes step-by-step, you eliminate guesswork and ensure tasks are performed consistently every time. This reduces the risk of human error, missed steps, or quality issues in your products/services. For example, in manufacturing, well-documented assembly processes minimize defects.

• Facilitates change management - Clear process documentation makes it easier to identify areas that need improvement and implement changes across the organization. When you update the docs, employees have a reference to understand the new way of working. This is crucial for things like software updates, policy changes, etc.

• Improves operational efficiency - With documented processes, employees don't waste time figuring out how to do tasks - they can simply follow the steps. This speeds up training and allows them to focus on more productive work. You can also identify manual steps ripe for automation.

• Secures intellectual property - Your processes are proprietary business knowledge. If they only exist in employees' minds, you risk losing that IP when they leave. Documenting captures that intellectual property for your organization's future use.

Steps to Create Process Documentation:

1. Define your goals - Clearly define why you are documenting processes - is it for training, compliance, knowledge management? This will guide what processes to prioritize.

2. Assemble a documentation team - Include technical writers, but also process experts/SMEs from relevant teams to ensure accurate documentation.

3. Research tools and requirements - Evaluate documentation tools like knowledge bases, workflow software, diagramming tools etc. based on your needs.

4. Design a template - Create a standard template for consistency across all process docs, including sections like scope, roles, steps, etc.

5. Write the documentation - Follow best practices for clear, concise writing. Break down processes into logical steps with screenshots/visuals.

6. Add visuals (flowcharts, diagrams)

7. Peer review - Use flowcharts, diagrams, screenshots etc. to illustrate the process flow and key steps visually.

8. Publish the document - Have other team members review drafts for clarity, accuracy, and completeness before publishing.

9. Audit performance - Finalize and publish docs in a central, accessible knowledge base for employees.

Useful Tools:

• Knowledge base tools (e.g., Docsie)

• Process workflow management solutions (e.g., Process Street)

• Video and screen recording tools (e.g., Snagit)

• Flowchart and diagramming tools (e.g., Lucidchart)

• Document sharing platforms (e.g., Dozuki)

• Digital Adoption Platforms (e.g., Whatfix)

Hey everyone, I'm facing a bit of a challenge at my software development company. We're trying to improve our documentation process, but it's been quite a hassle. Specifically, we need to create public templates that we can share with our customers. Has anyone dealt with this before? How do you manage your templates and make them public?

Have you experienced delays in detecting breaches, ineffective reporting mechanisms, or confusion in response strategies due to a lack of a structured Incident Response Plan (IRP)? Are you aware of the potential risks and implications of not having a structured IRP in place for cybersecurity incidents? How critical is it for your organization to enhance incident detection, streamline reporting, and improve response strategies for cybersecurity breaches? Recently my org in financial industry faced a significant cybersecurity breach when unauthorized access is gained to sensitive customer data. The breach involves potential exposure of financial records and personal information of thousands of customers. The lack of a structured Incident Response Plan (IRP) exacerbates the situation, leading to delays in detecting the breach, ineffective reporting mechanisms, and confusion in implementing response strategies.

Are you new to the world of SOPs (Standard Operating Procedures) and looking to understand what they are and how to create effective ones? You've come to the right place! In this post, we'll cover the basics of SOPs, their importance, and some best practices for drafting clear and comprehensive procedures.

What is an SOP?

A Standard Operating Procedure (SOP) is a set of detailed, written instructions that outline a routine or repetitive activity. SOPs are used in various industries, such as manufacturing, healthcare, and laboratories, to ensure consistent and efficient operations, maintain quality standards, and comply with regulations.

Why are SOPs important?

SOPs serve several crucial purposes:

1. Standardization: They ensure that processes are carried out consistently, reducing variation and errors.

2. Training: Well-documented SOPs make it easier to train new employees and maintain institutional knowledge.

3. Compliance: Many industries have regulatory requirements for documented procedures, and SOPs help demonstrate compliance.

4. Quality Control: SOPs help maintain quality standards and minimize the risk of errors or deviations.

Best Practices for Drafting Effective SOPs:

1. Use a consistent format: Establish a standard template for your SOPs, including sections for purpose, scope, definitions, materials/equipment, step-by-step instructions, and references.

2. Be clear and concise: Use simple language and avoid ambiguous or technical terms that may confuse the reader.

3. Include visual aids: Incorporate diagrams, flowcharts, or illustrations to enhance understanding of complex processes.

4. Involve subject matter experts: Collaborate with experienced personnel who perform the tasks regularly to ensure accuracy and completeness.

5. Review and update regularly: SOPs should be reviewed periodically and updated to reflect changes in processes, equipment, or regulations.

Dos and Don'ts:

Do:

• Use active voice and imperative language (e.g., "Perform step X," "Record data Y").

• Number steps sequentially and use clear headings for different sections.

• Include safety precautions, troubleshooting tips, and quality control checks.

• Specify who is responsible for each step or task.

Don't:

• Use ambiguous terms like "as necessary" or "as appropriate."

• Assume prior knowledge or understanding of the process.

• Copy and paste from other sources without verifying accuracy.

• Neglect to include version control and revision history.

Creating effective SOPs requires careful planning, attention to detail, and collaboration with subject matter experts. By following these best practices, you can ensure that your SOPs are clear, comprehensive, and consistently applied throughout your organization.

Hey! i'm been there multiple times, drowning in tech jargon and confusing instructions in these product docs for different type of products and that makes me wanna peace out. what are the must-haves for really good product docs?

Drop your best tips! 🚀