Writing Beautiful Technical Documentation

•Descargar como ODP, PDF•

6 recomendaciones•3,418 vistas

Subtitled: "Writing FOSS Docs That Don't Suck" A look at why documentation is so important for open source projects, and how to create documentation that does wonders for your project. Created for linux.conf.au 2010 in Wellington

Tecnología Empresariales

Creating Beautiful Open Source Technical Documentation Or: Writing FOSS Docs that Don't Suck

A long time ago in a galaxy far far away ...

Thursday My design skillz are made of awesome!

Information Plan Content Specification Writing Translation & Production Review Release 5 Phase Model by JoAnn Hackos

“ A common mistake that people make when trying to design something completely foolproof is to underestimate the ingenuity of complete fools ” Douglas Adams “Mostly Harmless”

These things all work the same for documentation

When users love the software then that's great software!

But when they don't ... the documentation should be there to save you

Beautiful documentation won't make crappy software any better But it might prevent some users from trying to stab you

Lana Brindley Red Hat Technical Writer [email_address] +61 410 500 659 @Loquacities http://lanabrindley.blogspot.com/

Más contenido relacionado

Destacado

Best Practices for Documenting Technical Procedures

Melanie Seibert

Guidelines for technical writing documents

Rajesh Singamsetty

Documenting Business Processes

Rachel Houghton

This presentation outlines industry best practices in writing/editing “user friendly” instruction/user manuals. Instruction/user manuals are written for the purpose of helping the end-user complete a task. These documents must be clear about its purpose. The technical writer must take into consideration the user’s attitude, education, and experience when composing such documents. Methods of organization include a table of contents, pagination, previews and reviews, cross references, glossary, and Index - alphabetical list and page numbers - for longer docs for ease of use. Warnings, cautions, and dangers should also be used throughout the text where appropriate. Appropriate visuals should be used only as needed to aid the user in understanding of the task at hand.

Best Practices for Writing and Editing User/Instruction Manuals

The Integral Worm

Great copy is critical to the effectiveness of nearly every website. Yet often, a business owner, designer, or developer, perhaps pressured by budget and time limitations, will write the copy him- or herself. This session will tell you when that's a good idea, and when it's not. For those times when it's okay to be the "accidental writer," you'll learn quick tips for crafting effective web copy. For those times when you really need to bring in a pro, you'll learn how to work with a web writer to get the best copy for your website, as quickly and cheaply as possible.

The Accidental Writer: Great Web Copy for Everyone

Melanie Seibert

How to create CAD designs to facilitate collaboration and inter-operability between designers and the rest of the team. Designers, often trapped by looming schedules and inadequate process, need tools to fulfill the demands of collaboration and inter-operability. This presentation will address a set of simple standards and processes that allow designers to include necessary data and modeling standards directly in their CAD models. They are quick and clear instructions that capture the information required by the entire team. This strategy facilitates collaboration among team members such as analysis, parts and materials, manufacturing and configuration management.

CAD MBD & 3D Technical Documentation

herronje

Presented by Scott Abel at the Society for Technical Communication Summit, June 2, 2008 in Philadelphia. Your user community can be an invaluable source of information about your product or service. Using Web 2.0 technologies, you can augment your existing technical documentation with user-generated content. The presentation will explore the possibilities, as well as the perils, of leveraging this often-overlooked resource.

Augmenting your Technical Documentation with User-Generated Content

Scott Abel

MediaWiki Quick Start Guide

Rajesh Singamsetty

Incorporating Visual Communication in Technical Documentation, for Usability!

kate k

Technical Documentation Solutions

antugarg

Technical documentation and visual clues

tms support solutions ltd

Language is one of those magic tools that helps us sharing thoughts, ideas, feelings. As we all experience every day it’s not an easy task… You need to be a true wordsmith to make your message clear, easy to understand, and what’s most important generating the appropriate energy in your audience. It’s especially important when you’re a Tech Writer. You have the power to help end user fail in love with the product or hate it and abandon… There’s a wide variety of a daily challenges. One of them is how to write help in a appealing for the user way? Geeky/technical language is extremely boring – most of us hardly ever even start reading the help. But… What if reading help was as exciting as reading a good thriller? What if while learning new feature user would feel as an adventurous explorer solving gripping puzzles? One of the ways to achieve it is to use gamification and storytelling.

Monika Konieczny - Gamification & storytelling: how to turn boring technical ...

soapconf

Terminology Management Best Practices

SDL

MSTP

Rajesh Singamsetty

Achim Steinacker: Technical Documentation in the age of Industry 4.0

Semantic Web Company

This is a draft of the presentation that will be given at the HEA Social Sciences annual conference - Teaching forward: the future of the Social Sciences. For further details of the conference: http://bit.ly/1cRDx0p Bookings open until 14 May 2014 http://bit.ly/1hzCMLR or external.events@heacademy.ac.uk ABSTRACT The paper presents the findings of a HEA-CLL funded project focussing on encouraging students to cocreate and use OERs via interdisciplinary study guides on research methods. Students were asked to review the tutor-produced study guides developed on a Google website/wiki and to add resources to the study guide via a comments feature. In focus interviews, they were asked if they were willing to take ownership of the guides. Students’ views on student-led guides indicated an interest in this pedagogical approach, but had issues around trusting their peers’ ability to make reliable judgements. These findings will be explored in our paper.

Passing the baton: trusting students with the co-creation and ownership of OE...

The Higher Education Academy

Technical Documentation *Passing the baton*

Vinish Garg

Internet Of Things

johnson jawahar

Jetzt zum #IoT Web Day anmelden: https://aws.amazon.com/de/campaigns/iot-webday/ Das Internet der Dinge ist in aller Munde, doch was versteht man eigentlich unter dem Begriff “Internet of Things”? Und wo liegen die Herausforderungen wenn man Milliarden an Geräten und Billionen von Nachrichten in einem globalen Maßstab unterstützen muss? Antworten auf diese Fragen gibt es in diesem Kurzüberblick. Über AWS IoT informieren: https://aws.amazon.com/de/iot/

IoT Breakfast - AWS Amazon Web Services - Internet of Things

AWS Germany

Plan lector paco yunque

juan antonio cupe cuenca

Destacado (20)

Best Practices for Documenting Technical Procedures

Guidelines for technical writing documents

Documenting Business Processes

Best Practices for Writing and Editing User/Instruction Manuals

The Accidental Writer: Great Web Copy for Everyone

CAD MBD & 3D Technical Documentation

Augmenting your Technical Documentation with User-Generated Content

MediaWiki Quick Start Guide

Incorporating Visual Communication in Technical Documentation, for Usability!

Technical Documentation Solutions

Technical documentation and visual clues

Monika Konieczny - Gamification & storytelling: how to turn boring technical ...

Terminology Management Best Practices

MSTP

Achim Steinacker: Technical Documentation in the age of Industry 4.0

Passing the baton: trusting students with the co-creation and ownership of OE...

Technical Documentation *Passing the baton*

Internet Of Things

IoT Breakfast - AWS Amazon Web Services - Internet of Things

Plan lector paco yunque

Think It. Make It. Change the World.

Getting Women into Open Source - The Easy Way

Getting started With Linux: how NOT to do it.

Technical writing: A fairy tale

10 Reasons why you should not install Linux. Ever

Último

Histor y of HAM Radio presentation slide

vu2urc

Finology Group – Insurtech Innovation Award 2024

The Digital Insurer

Microsoft's Threat Matrix for Kubernetes helps organizations understand the attack surface a Kubernetes deployment introduces to their environments. This ensures that adequate detections and mitigations are in place. By covering over 40 different attacker techniques, defenders can learn about Kubernetes-specific mitigations and controls to deploy to their environments. In this session, we will explore the MS-TA9013 Host Path Mount technique, which is commonly used by attackers to perform privilege escalation in a Kubernetes cluster. Attendees will learn how attackers and defenders can: * Escape the container's host volume mount to gain persistence on an underlying node * Move laterally from the underlying node into the customer's cloud environment * Analyze Kubernetes audit logs to detect pods deployed with a hostPath mount * Deploy an admission controller that prevents new pods from using a hostPath mount

Breaking the Kubernetes Kill Chain: Host Path Mount

Puma Security, LLC

Enterprise Knowledge’s Urmi Majumder, Principal Data Architecture Consultant, and Fernando Aguilar Islas, Senior Data Science Consultant, presented "Driving Behavioral Change for Information Management through Data-Driven Green Strategy" on March 27, 2024 at Enterprise Data World (EDW) in Orlando, Florida. In this presentation, Urmi and Fernando discussed a case study describing how the information management division in a large supply chain organization drove user behavior change through awareness of the carbon footprint of their duplicated and near-duplicated content, identified via advanced data analytics. Check out their presentation to gain valuable perspectives on utilizing data-driven strategies to influence positive behavioral shifts and support sustainability initiatives within your organization. In this session, participants gained answers to the following questions: - What is a Green Information Management (IM) Strategy, and why should you have one? - How can Artificial Intelligence (AI) and Machine Learning (ML) support your Green IM Strategy through content deduplication? - How can an organization use insights into their data to influence employee behavior for IM? - How can you reap additional benefits from content reduction that go beyond Green IM?

Driving Behavioral Change for Information Management through Data-Driven Gree...

Enterprise Knowledge

Real Time Object Detection Using Open CV

Khem

Discord is a free app offering voice, video, and text chat functionalities, primarily catering to the gaming community. It serves as a hub for users to create and join servers tailored to their interests. Discord’s ecosystem comprises servers, each functioning as a distinct online community with its own channels dedicated to specific topics or activities. Users can engage in text-based discussions, voice calls, or video chats within these channels. Understanding Discord Servers Discord servers are virtual spaces where users congregate to interact, share content, and build communities. Servers may revolve around gaming, hobbies, interests, or fandoms, providing a platform for like-minded individuals to connect. Communication Features Discord offers a range of communication tools, including text channels for messaging, voice channels for real-time audio conversations, and video channels for face-to-face interactions. These features facilitate seamless communication and collaboration. What Does NSFW Mean? The acronym NSFW stands for “Not Safe For Work,” indicating content that may be inappropriate for professional or public settings. NSFW Content NSFW content encompasses material that is sexually explicit, violent, or otherwise graphic in nature. It often includes nudity, profanity, or depictions of sensitive topics.

Understanding Discord NSFW Servers A Guide for Responsible Users.pdf

UK Journal

A Call to Action for Generative AI in 2024

Results

🐬 The future of MySQL is Postgres 🐘

RTylerCroy

Boost Fertility New Invention Ups Success Rates.pdf

sudhanshuwaghmare1

How to Troubleshoot Apps for the Modern Connected Worker

ThousandEyes

What is a good lead in your organisation? Which leads are priority? What happens to leads? When sales and marketing give different answers to these questions, or perhaps aren't sure of the answers at all, frustrations build and opportunities are left on the table. Join us for an illuminating session with Cian McLoughlin, HubSpot Principal Customer Success Manager, as we look at that crucial piece of the customer journey in which leads are transferred from marketing to sales.

04-2024-HHUG-Sales-and-Marketing-Alignment.pptx

HampshireHUG

BooK Now Call us at +918448380779 to hire a gorgeous and seductive call girl for sex. Take a Delhi Escort Service. The help of our escort agency is mostly meant for men who want sexual Indian Escorts In Delhi NCR. It should be noted that any impersonator will get 100 attention from our Young Girls Escorts in Delhi. They will assume the position of reliable allies. VIP Call Girl With Original Photos Book Tonight +918448380779 Our Cheap Price 1 Hour not available 2 Hours 5000 Full Night 8000 TAG: Call Girls in Delhi, Noida, Gurgaon, Ghaziabad, Connaught Place, Greater Kailash Delhi, Lajpat Nagar Delhi, Mayur Vihar Delhi, Chanakyapuri Delhi, New Friends Colony Delhi, Majnu Ka Tilla, Karol Bagh, Malviya Nagar, Saket, Khan Market, Noida Sector 18, Noida Sector 76, Noida Sector 51, Gurgaon Mg Road, Iffco Chowk Gurgaon, Rajiv Chowk Gurgaon All Delhi Ncr Free Home Deliver

08448380779 Call Girls In Civil Lines Women Seeking Men

Delhi Call girls

Sara Mae O’Brien Scott and Tatiana Baquero Cakici, Senior Consultants at Enterprise Knowledge (EK), presented “AI Fast Track to Search-Focused AI Solutions” at the Information Architecture Conference (IAC24) that took place on April 11, 2024 in Seattle, WA. In their presentation, O’Brien-Scott and Cakici focused on what Enterprise AI is, why it is important, and what it takes to empower organizations to get started on a search-based AI journey and stay on track. The presentation explored the complexities of enterprise search challenges and how IA principles can be leveraged to provide AI solutions through the use of a semantic layer. O’Brien-Scott and Cakici showcased a case study where a taxonomy, an ontology, and a knowledge graph were used to structure content at a healthcare workforce solutions organization, providing personalized content recommendations and increasing content findability. In this session, participants gained insights about the following: Most common types of AI categories and use cases; Recommended steps to design and implement taxonomies and ontologies, ensuring they evolve effectively and support the organization’s search objectives; Taxonomy and ontology design considerations and best practices; Real-world AI applications that illustrated the value of taxonomies, ontologies, and knowledge graphs; and Tools, roles, and skills to design and implement AI-powered search solutions.

IAC 2024 - IA Fast Track to Search Focused AI Solutions

Enterprise Knowledge

Automating Google Workspace (GWS) & more with Apps Script

wesley chun

This presentations targets students or working professionals. You may know Google for search, YouTube, Android, Chrome, and Gmail, but did you know Google has many developer tools, platforms & APIs? This comprehensive yet still high-level overview outlines the most impactful tools for where to run your code, store & analyze your data. It will also inspire you as to what's possible. This talk is 50 minutes in length.

Powerful Google developer tools for immediate impact! (2023-24 C)

wesley chun

GenCyber Cyber Security Day Presentation

Michael W. Hawkins

08448380779 Call Girls In Greater Kailash - I Women Seeking Men

Delhi Call girls

08448380779 Call Girls In Friends Colony Women Seeking Men

Delhi Call girls

In an era where artificial intelligence (AI) stands at the forefront of business innovation, Information Architecture (IA) is at the core of functionality. See “There’s No AI Without IA” – (from 2016 but even more relevant today) Understanding and leveraging how Information Architecture (IA) supports AI synergies between knowledge engineering and prompt engineering is critical for senior leaders looking to successfully deploy AI for internal and externally facing knowledge processes. This webinar be a high-level overview of the methodologies that can elevate AI-driven knowledge processes supporting both employees and customers. Core Insights Include: Strategic Knowledge Engineering: Delve into how structuring AI's knowledge base is required to prevent hallucinations, enable contextual retrieval of accurate information. This will include discussion of gold standard libraries of use cases support testing various LLMs and structures and configurations of knowledge base. Precision in Prompt Engineering: Learn the art of crafting prompts that direct AI to deliver targeted, relevant responses, thereby optimizing customer experiences and business outcomes. Unified Approach for Enhanced AI Performance: Explore the intersection of knowledge and prompt engineering to develop AI systems that are not only more responsive but also aligned with overarching business strategies. Guiding Principles for Implementation: Equip yourself with best practices, ethical guidelines, and strategic considerations for embedding these technologies into your business ecosystem effectively. This webinar is designed to empower business and technology leaders with the knowledge to harness the full potential of AI, ensuring their organizations not only keep pace with digital transformation but lead the charge. Join us to map a roadmap to fully leverage Information Architecture (IA) and AI chart a course towards a future where AI is a key pillar of strategic innovation and business success.

EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx

Earley Information Science

The 7 Things I Know About Cyber Security After 25 Years | April 2024

Rafal Los

Writing Beautiful Technical Documentation

1. Creating Beautiful Open Source Technical Documentation Or: Writing FOSS Docs that Don't Suck

4. Technical Writing A Fairy Tale

5. A long time ago in a galaxy far far away ...

6. Jane

7. Fred Sue Bob

8. Monday

9. Tuesday

10. Tuesday My l337 db rawks!

11. Wednesday

12. Wednesday My h4X0r skills are teh win!

13. Thursday

14. Thursday My design skillz are made of awesome!

15. Friday

16. Friday WTF?!

17. Friday

18. Friday My l337 db rawks!

19. Friday My h4X0r skills are teh win!

20. Friday All users base are belong to us

21. Friday

22. Saturday

23. Sunday

24. Monday Ship it!

25. Tuesday

26. Wednesday

27. Thursday

28. Thursday ???

29. Thursday !!!

30. Thursday $*!%

31. Friday Dole queue

32. Just because you can READ a manual ...

33. Doesn't mean you can write one.

34. Happily Ever After?

35. Information Plan Content Specification Writing Translation & Production Review Release 5 Phase Model by JoAnn Hackos

36. “ A common mistake that people make when trying to design something completely foolproof is to underestimate the ingenuity of complete fools ” Douglas Adams “Mostly Harmless”

37.

38.

39.

40.

41.

42. How To: Write FOSS Docs that don't suck

43. no one reads manuals! But ...

44. Why Document?

45. What makes your software awesome?

46. These things all work the same for documentation

47. Learnability

48. Efficiency