Write the docs

•

0 likes•76 views

The document discusses how blogging can be used as a non-traditional form of documentation that has several benefits over traditional documentation. Blogging allows information to be introduced incrementally, allows two-way interaction between users and staff through comments, and helps build relationships between authors and readers. Blogging also has a lower barrier to entry than reworking an entire documentation system, and allows experimentation to improve documentation over time.

Technology

Blogging as
Non-Traditional Support
Documentation
Elizabeth Urello - @eurello
elizabeth@automattic.com
WordPress.com Happiness Engineer
Tuesday, April 1, 14

Readers Can Subscribe
• Blogging provides an incremental
introduction to various topics.
• Email updates are occasional prompts to
keep learning.
• Subscribing to a blog builds knowledge in a
gradual and fun way.
Tuesday, April 1, 14

Blogging Turns
Documentation Into
Conversation
• Readers can comment, and staff can reply.
• Readers can use sharing buttons to
promote the post.
Tuesday, April 1, 14

Blogs Have Authors
• Regular readers get to know the writers of
the blog.
• This creates an ongoing relationship
between staff and users that is based
around creativity and proactive support
rather than merely troubleshooting.
Tuesday, April 1, 14

More People Can Blog
• Not all staff members will know how to
construct technical documentation, but
most can write a blog post.
• Creates an opportunity for developers and
others to interact with users.
Tuesday, April 1, 14

Blogs Can Be a Fresh Start
• It’s easier to begin a new blog than to
overhaul your entire support
documentation system.
• Blogging lets you experiment.
• What you learn from blogging can then be
applied to the documentation.
Tuesday, April 1, 14

The WordPress.com Blog
(en.blog.wordpress.com)
Tuesday, April 1, 14

Introduce New Features and Partnerships:
Tuesday, April 1, 14

Explore a certain topic/feature in depth:
Tuesday, April 1, 14

Interview staff & articles highlight our bloggers:
Tuesday, April 1, 14

Announce Automattic activity:
Tuesday, April 1, 14

The Daily Post
(dailypost.wordpress.com)
Tuesday, April 1, 14

Weekly Photo and Writing Challenges:
Tuesday, April 1, 14

Task-Based Instruction:
Tuesday, April 1, 14

General advice on writing and blogging:
Tuesday, April 1, 14

Interviews with our bloggers:
Tuesday, April 1, 14

•ZTH Participants: Posted an average of 9.6
times per blog
•This was about an 89% jump in posting
from the previous month for these users
•Random sample: Posted an average 0.2
times
•Participants voluntarily used shortcodes!!
This means that consistent blogging by staff helped
those users publish 48 times as often as a control
group!
Tuesday, April 1, 14

• Blogs promote incremental learning and
ongoing engagement.
• Blogging turns documentation into
conversation, and helps you build positive
relationships with your users.
• Blogging is fun for the whole company!
• Blogging is a low-investment, easy fresh
start and ongoing “dev site” for
experimentation and iteration on your
existing support documentation.
In Sum:
Tuesday, April 1, 14

Similar to Write the docs

Catering for different_student_profile_eaquals 2014 (schmid-walton)

eaquals

3.7.jacobs

afacct

Blogging

SpringH1

No Blogging to Know Blogging Hangout with Prakash

Prakash Poudel

Adding value to you postgrad studies

School of Economics, North-West University

Syllabus quiz for Technical Writing

Matthew Spicuzza

P.L.E

1992199200

Blogs

hidalgogjulioc20

Blogging for nature 2: Blockheads to Blogheads

November Tan

ITC St. Pete 2017

mnkaleidoscope

Assessment in he 2014 online introduction

Rachel Forsyth

97 2003

guestf568b97

Final Powerpoint project

guestf568b97

Managing Multiple Authors with WordPress

Al Davis

EDUC w200 powerpoint

klj4

Blogging week

Maria Soledad Bernardi

A common question in the mind of every individual is the "stage fear of presentation" in a public forum such as Null meet. I'd be addressing this question in my talk titled " Why should I speak in Null Meet? " It would address common queries which many people have ( esp. Introverts) but don't ask readily in fear of rejection / ridiculed upon by peers etc. I'd be drawing examples based on my experience how and why I started presenting in Null Meets. I was too in similar situation few years back when I first started out in the industry:) This talk focuses on the practical side of the benefits of public speaking in esp. in Infosec domain. The points that would be in focus will be as follows: Why should I involve myself in Public speaking ? Isn't passive listening and working individually good enough? How can I start ? From where I can begin? Addressing the hidden fears Answering your mental blocks How does it help in my career? How does it help me? Takeaways

Why should I speak in Null meet?

Manas Deep

Welcome to experience web 2

kennyr

Blogs in the classroom

mrcordy22

4 Steps to Develop Comprehension and Analysis Skills at Home

Oxford Tutoring

Similar to Write the docs (20)

Catering for different_student_profile_eaquals 2014 (schmid-walton)

3.7.jacobs

Blogging

No Blogging to Know Blogging Hangout with Prakash

Adding value to you postgrad studies

Syllabus quiz for Technical Writing

P.L.E

Blogs

Blogging for nature 2: Blockheads to Blogheads

ITC St. Pete 2017

Assessment in he 2014 online introduction

97 2003

Final Powerpoint project

Managing Multiple Authors with WordPress

EDUC w200 powerpoint

Blogging week

Why should I speak in Null meet?

Welcome to experience web 2

Blogs in the classroom

4 Steps to Develop Comprehension and Analysis Skills at Home

Recently uploaded

Watch this recorded webinar about real-time monitoring of application performance. See how to integrate Apache JMeter, the open-source leader in performance testing, with InfluxDB, the open-source time-series database, and Grafana, the open-source analytics and visualization application. In this webinar, we will review the benefits of leveraging InfluxDB and Grafana when executing load tests and demonstrate how these tools are used to visualize performance metrics. Length: 30 minutes Session Overview ------------------------------------------- During this webinar, we will cover the following topics while demonstrating the integrations of JMeter, InfluxDB and Grafana: - What out-of-the-box solutions are available for real-time monitoring JMeter tests? - What are the benefits of integrating InfluxDB and Grafana into the load testing stack? - Which features are provided by Grafana? - Demonstration of InfluxDB and Grafana using a practice web application To view the webinar recording, go to: https://www.rttsweb.com/jmeter-integration-webinar

JMeter webinar - integration with InfluxDB and Grafana

RTTS

When stars align: studies in data quality, knowledge graphs, and machine lear...

Elena Simperl

Explore the core of Salesforce success in 'Salesforce Adoption – Metrics, Methods, and Motivation.' We will discuss essential metrics, effective methods to drive adoption, and the driving force behind user engagement and explore strategies for onboarding, training, and continuous support that empower users to navigate the platform seamlessly. By leveraging these tools, you can effectively measure adoption against your company’s goals and create an environment where users not only adopt Salesforce but actively contribute to its ongoing success.

Salesforce Adoption – Metrics, Methods, and Motivation, Antone Kom

CzechDreamin

Ever caught yourself nodding along when someone mentions "delivering value" in Agile, but secretly wondering what the heck they actually mean? You're not alone! Join us for an eye-opening session where we'll strip away the buzzwords and dive into the heart of Agile—value delivery. But what is "value"? Is it a mythical unicorn in the world of software development, or is there more to this overused term? This isn't going to be a sit-and-get lecture. We're talking about a face-to-face, interactive meetup where YOU play a crucial role. Come along to: Define It: What does "value" really mean? We’ll build a definition that’s not just words, but a compass for your Agile journey. Contextualise It: Discover what value means specifically to you, your team, your company, and your industry. Because one size does not fit all. Deliver It: Share strategies and gather new ones for uncovering and delivering true value—no more shooting in the dark!

Unpacking Value Delivery - Agile Oxford Meetup - May 2024.pptx

David Michel

ODC, Data Fabric and Architecture User Group

CatarinaPereira64715

💥 Speed, accuracy, and scaling – discover the superpowers of GenAI in action with UiPath Document Understanding and Communications Mining™: See how to accelerate model training and optimize model performance with active learning Learn about the latest enhancements to out-of-the-box document processing – with little to no training required Get an exclusive demo of the new family of UiPath LLMs – GenAI models specialized for processing different types of documents and messages This is a hands-on session specifically designed for automation developers and AI enthusiasts seeking to enhance their knowledge in leveraging the latest intelligent document processing capabilities offered by UiPath. Speakers: 👨‍🏫 Andras Palfi, Senior Product Manager, UiPath 👩‍🏫 Lenka Dulovicova, Product Program Manager, UiPath

Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...

UiPathCommunity

Unsubscribed: Combat Subscription Fatigue With a Membership Mentality by Head...

Product School

How to differentiate Sales Cloud and CPQ on first glance might be tricky if you do not know where to look and what to look at. You will know :-) Managing the sales process within Salesforce is a common use case that can be managed with standart Sales Cloud. If you want to do entire quoting process you will find out Salesforce CPQ solution exists. What is then the difference if both can handle selling products? You will see comparison of 10 different features, which Sales Cloud and Salesforce CPQ handle differently. Simple question you will always remember if you should consider using Salesforce CPQ will be a cherry on top.

10 Differences between Sales Cloud and CPQ, Blanka Doktorová

CzechDreamin

Join us as we dive into the latest updates to the UiPath Orchestrator API, including new limits and features for 2024. Discover how these changes can enhance your automation projects and streamline your workflows. 📚 Overview of UiPath Orchestrator API 🔧 Recent changes to API limits 🛠️ How to adapt to new limits 📋 Best practices for using the Orchestrator API efficiently ❓ Q&A session

Exploring UiPath Orchestrator API: updates and limits in 2024 🚀

DianaGray10

ScyllaDB has the potential to deliver impressive performance and scalability. The better you understand how it works, the more you can squeeze out of it. But before you squeeze, make sure you know what to monitor! Watch our experienced Postgres developer work through monitoring and performance strategies that help him understand what mistakes he’s made moving to NoSQL. And learn with him as our database performance expert offers friendly guidance on how to use monitoring and performance tuning to get his sample Rust application on the right track. This webinar focuses on using monitoring and performance tuning to discover and correct mistakes that commonly occur when developers move from SQL to NoSQL. For example: - Common issues getting up and running with the monitoring stack - Using the CQL optimizations dashboard - Common issues causing high latency in a node - Common issues causing replica imbalance - What a healthy system looks like in terms of memory - Key metrics to keep an eye on This isn’t “Death-by-Powerpoint.” We’ll walk through problems encountered while migrating a real application from Postgres to ScyllaDB – and try to fix them live as well.

Optimizing NoSQL Performance Through Observability

ScyllaDB

New customer? New industry? New cloud? New team? A lot to handle! How to ensure the success of the project? Start it well! I've created the 3 areas of focus at the beginning of the project that helped me in multiple roles (BA, PO, and Consultant). Learn from real-world experiences and discover how these insights can empower you to deliver unparalleled value to your customers right from the project's start.

Powerful Start- the Key to Project Success, Barbara Laskowska

CzechDreamin

Are you looking to streamline your workflows and boost your projects’ efficiency? Do you find yourself searching for ways to add flexibility and control over your FME workflows? If so, you’re in the right place. Join us for an insightful dive into the world of FME parameters, a critical element in optimizing workflow efficiency. This webinar marks the beginning of our three-part “Essentials of Automation” series. This first webinar is designed to equip you with the knowledge and skills to utilize parameters effectively: enhancing the flexibility, maintainability, and user control of your FME projects. Here’s what you’ll gain: - Essentials of FME Parameters: Understand the pivotal role of parameters, including Reader/Writer, Transformer, User, and FME Flow categories. Discover how they are the key to unlocking automation and optimization within your workflows. - Practical Applications in FME Form: Delve into key user parameter types including choice, connections, and file URLs. Allow users to control how a workflow runs, making your workflows more reusable. Learn to import values and deliver the best user experience for your workflows while enhancing accuracy. - Optimization Strategies in FME Flow: Explore the creation and strategic deployment of parameters in FME Flow, including the use of deployment and geometry parameters, to maximize workflow efficiency. - Pro Tips for Success: Gain insights on parameterizing connections and leveraging new features like Conditional Visibility for clarity and simplicity. We’ll wrap up with a glimpse into future webinars, followed by a Q&A session to address your specific questions surrounding this topic. Don’t miss this opportunity to elevate your FME expertise and drive your projects to new heights of efficiency.

Essentials of Automations: Optimizing FME Workflows with Parameters

Safe Software

De-mystifying Zero to One: Design Informed Techniques for Greenfield Innovati...

Product School

As AI technology is pushing into IT I was wondering myself, as an “infrastructure container kubernetes guy”, how get this fancy AI technology get managed from an infrastructure operational view? Is it possible to apply our lovely cloud native principals as well? What benefit’s both technologies could bring to each other? Let me take this questions and provide you a short journey through existing deployment models and use cases for AI software. On practical examples, we discuss what cloud/on-premise strategy we may need for applying it to our own infrastructure to get it to work from an enterprise perspective. I want to give an overview about infrastructure requirements and technologies, what could be beneficial or limiting your AI use cases in an enterprise environment. An interactive Demo will give you some insides, what approaches I got already working for real.

Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024

Tobias Schneck

The standard Salesforce Approval process can be limiting in many ways, especially in complex scenarios. What if there was a way to implement very flexible approvals where one can use Apex code to make data updates in unrelated records, dynamically generate next steps details, and compute assignees on the fly? And still use UI-based configurations to implement concrete approval processes. In this session, we will share ideas behind such a solution and show a few lines of code to get you started.

Custom Approval Process: A New Perspective, Pavel Hrbacek & Anindya Halder

CzechDreamin

IOS-PENTESTING-BEGINNERS-PRACTICAL-GUIDE-.pptx

Abida Shariff

The field of Information retrieval (IR) is currently undergoing a transformative shift, at least partly due to the emerging applications of generative AI to information access. In this talk, we will deliberate on the sociotechnical implications of generative AI for information access. We will argue that there is both a critical necessity and an exciting opportunity for the IR community to re-center our research agendas on societal needs while dismantling the artificial separation between the work on fairness, accountability, transparency, and ethics in IR and the rest of IR research. Instead of adopting a reactionary strategy of trying to mitigate potential social harms from emerging technologies, the community should aim to proactively set the research agenda for the kinds of systems we should build inspired by diverse explicitly stated sociotechnical imaginaries. The sociotechnical imaginaries that underpin the design and development of information access technologies needs to be explicitly articulated, and we need to develop theories of change in context of these diverse perspectives. Our guiding future imaginaries must be informed by other academic fields, such as democratic theory and critical theory, and should be co-developed with social science scholars, legal scholars, civil rights and social justice activists, and artists, among others.

Search and Society: Reimagining Information Access for Radical Futures

Bhaskar Mitra

Already know how to write a basic SOQL query? Great! But what about an *aggregate* SOQL query? You know, the kind that uses aggregate functions like COUNT & MAX along with GROUP BY and HAVING clauses? No? Well, get ready to learn how to slice & dice your org’s data right inside your own dev console. From finding duplicate records to prototyping summary & matrix reports, learn the ins and outs of aggregate queries during this fast-paced but admin-friendly session on advanced SOQL concepts.

SOQL 201 for Admins & Developers: Slice & Dice Your Org’s Data With Aggregate...

CzechDreamin

Intrigued by why some of the world's largest companies (Netflix, Google, Cisco, Twitter, Uber etc) are using gRPC? In this demo based talk we delve into the world of gRPC in .Net, what it does and why we should use it. We compare the interface with both Rest and graphQL. We will show you how to implement grpc server-side in .net and in the web. Finally, I will show you how the tooling helps you deliver powerful interfaces and interact with them quickly and simply.

Demystifying gRPC in .Net by John Staveley

John Staveley

You’ve heard good data matters in Machine Learning, but does it matter for Generative AI applications? Corporate data often differs significantly from the general Internet data used to train most foundation models. Join me for a demo on building an open source RAG (Retrieval Augmented Generation) stack using Milvus vector database for Retrieval, LangChain, Llama 3 with Ollama, Ragas RAG Eval, and optional Zilliz cloud, OpenAI.

Introduction to Open Source RAG and RAG Evaluation

Zilliz

Recently uploaded (20)

JMeter webinar - integration with InfluxDB and Grafana

When stars align: studies in data quality, knowledge graphs, and machine lear...

Salesforce Adoption – Metrics, Methods, and Motivation, Antone Kom

Unpacking Value Delivery - Agile Oxford Meetup - May 2024.pptx

ODC, Data Fabric and Architecture User Group

Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...

Unsubscribed: Combat Subscription Fatigue With a Membership Mentality by Head...

10 Differences between Sales Cloud and CPQ, Blanka Doktorová

Exploring UiPath Orchestrator API: updates and limits in 2024 🚀

Optimizing NoSQL Performance Through Observability

Powerful Start- the Key to Project Success, Barbara Laskowska

Essentials of Automations: Optimizing FME Workflows with Parameters

De-mystifying Zero to One: Design Informed Techniques for Greenfield Innovati...

Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024

Custom Approval Process: A New Perspective, Pavel Hrbacek & Anindya Halder

IOS-PENTESTING-BEGINNERS-PRACTICAL-GUIDE-.pptx

Search and Society: Reimagining Information Access for Radical Futures

SOQL 201 for Admins & Developers: Slice & Dice Your Org’s Data With Aggregate...

Demystifying gRPC in .Net by John Staveley

Introduction to Open Source RAG and RAG Evaluation

Write the docs

1. Blogging as Non-Traditional Support Documentation Elizabeth Urello - @eurello elizabeth@automattic.com WordPress.com Happiness Engineer Tuesday, April 1, 14

2. Why Blog? Tuesday, April 1, 14

3. Readers Can Subscribe • Blogging provides an incremental introduction to various topics. • Email updates are occasional prompts to keep learning. • Subscribing to a blog builds knowledge in a gradual and fun way. Tuesday, April 1, 14

4. Blogging Turns Documentation Into Conversation • Readers can comment, and staff can reply. • Readers can use sharing buttons to promote the post. Tuesday, April 1, 14

5. Blogs Have Authors • Regular readers get to know the writers of the blog. • This creates an ongoing relationship between staff and users that is based around creativity and proactive support rather than merely troubleshooting. Tuesday, April 1, 14

6. More People Can Blog • Not all staff members will know how to construct technical documentation, but most can write a blog post. • Creates an opportunity for developers and others to interact with users. Tuesday, April 1, 14

7. Tuesday, April 1, 14

8. Blogs Can Be a Fresh Start • It’s easier to begin a new blog than to overhaul your entire support documentation system. • Blogging lets you experiment. • What you learn from blogging can then be applied to the documentation. Tuesday, April 1, 14

9. The WordPress.com Blog (en.blog.wordpress.com) Tuesday, April 1, 14

10. Introduce New Features and Partnerships: Tuesday, April 1, 14

11. Explore a certain topic/feature in depth: Tuesday, April 1, 14

12. Interview staff & articles highlight our bloggers: Tuesday, April 1, 14

13. Announce Automattic activity: Tuesday, April 1, 14

14. The Daily Post (dailypost.wordpress.com) Tuesday, April 1, 14

15. Weekly Photo and Writing Challenges: Tuesday, April 1, 14

16. Daily Prompts: Tuesday, April 1, 14

17. Task-Based Instruction: Tuesday, April 1, 14

18. General advice on writing and blogging: Tuesday, April 1, 14

19. Interviews with our bloggers: Tuesday, April 1, 14

20. Tuesday, April 1, 14

21. Tuesday, April 1, 14

22. Tuesday, April 1, 14

23. Tuesday, April 1, 14

24. Tuesday, April 1, 14

25. •ZTH Participants: Posted an average of 9.6 times per blog •This was about an 89% jump in posting from the previous month for these users •Random sample: Posted an average 0.2 times •Participants voluntarily used shortcodes!! This means that consistent blogging by staff helped those users publish 48 times as often as a control group! Tuesday, April 1, 14

26. • Blogs promote incremental learning and ongoing engagement. • Blogging turns documentation into conversation, and helps you build positive relationships with your users. • Blogging is fun for the whole company! • Blogging is a low-investment, easy fresh start and ongoing “dev site” for experimentation and iteration on your existing support documentation. In Sum: Tuesday, April 1, 14

Write the docs

Recommended

Recommended

More Related Content

Similar to Write the docs

Similar to Write the docs (20)

Recently uploaded

Recently uploaded (20)

Write the docs