To spread beyond the early adopters and reach a mainstream audience, a software project requires good documentation and training materials. This presentation looks at some research into documentation, examines some examples, and proposes solutions.
The world depends on useful data, and so does your organization. You need software to store, share, manage, and process the data--software that costs as little as possible (hopefully nothing), whose workings are open to inspection, are guaranteed not to go away, and are accompanied by communities of people who understand the tools well. You need open source software. This small set of slides introduce what free and open source software is, its importance, why it thrives in communities of practitioners, and a few principles for benefitting from it. (Two new slides were added on April 3, 2016, about assessing a project's maturity.)
The Scope of Health Information Technology: Progress and ChallengesAndrew Oram
Presents an overview of health IT technologies, such as devices, telehealth, electronic health records, analytics, coordinated care, and health information exchange. The goal is not just to list trends but to show their relationships and dependencies, suggest ways they can contribute to improvement in health care, and provide frameworks for understanding their strengths, weaknesses, and impacts.
The world depends on useful data, and so does your organization. You need software to store, share, manage, and process the data--software that costs as little as possible (hopefully nothing), whose workings are open to inspection, are guaranteed not to go away, and are accompanied by communities of people who understand the tools well. You need open source software. This small set of slides introduce what free and open source software is, its importance, why it thrives in communities of practitioners, and a few principles for benefitting from it. (Two new slides were added on April 3, 2016, about assessing a project's maturity.)
The Scope of Health Information Technology: Progress and ChallengesAndrew Oram
Presents an overview of health IT technologies, such as devices, telehealth, electronic health records, analytics, coordinated care, and health information exchange. The goal is not just to list trends but to show their relationships and dependencies, suggest ways they can contribute to improvement in health care, and provide frameworks for understanding their strengths, weaknesses, and impacts.
Its a very nice presenttion on forest our lifeling, They are Green Lungs of the environmentso just open the presentation on i am sure u will be loving that
Are you scared of that algebraic sums? Just view this presentation an you can learn about each and every algebraic identities. Just view this and Now take full marks in your tests..
VERY ATTRACTIVE PRESENTATION CONTAINING THE FOLLOWING SLIDES: Agriculture, Crops, , Agricultural practices, Irrigation, Water logging, Weeding, Storage, Mixed Cultivation and Crop Rotation, NItrogen Fixation, Nitrogen Cycle, Animal Husbandary and many more
Explains the benefits and drawbacks of open source software. Explores various open source software used in libraries and the future of open library data.
Context, Coffee, and the Death of Crapplications: Enabling Great Global UXUltan O'Broin
Understand how and why context is king for localization, translation, and user experience alike. Find out what context of use is, and how it relates to requirements and implementation of software being used globally. Understand why translation is UX, and more. Great examples and best practices make this presentation come to life in a real way for novice, seasoned, and start up globalizers. Next time you're in Starbucks or Peets you'll remember the importance of context!
The Technical Writers Guide to Contributing to Open Source ProjectsAll Things Open
Presented by: Edidiong Asikpo, Hashnode
Presented at All Things Open 2020
Abstract: The documentation of an open source project provides an avenue for users to not only understand the project but also make contributions to it. Surveys (https://cdn2.hubspot.net/hubfs/4008838/Resources/The-2019-Tidelift-managed-open-source-survey-results.pdf) have even shown that a good documentation saves as a sign of the healthiness of an open source project.
However, technical writers still think they are not meant to contribute to open source projects because of the stereotype that only software engineers are meant to contribute to open source.
In this talk, I will introduce the audience to how technical writers can contribute to open source projects, best practices, and it’s benefits.
The changing nature of technical content (tekom tcworld 2013 conference)Ellis Pratt
There have been many developments in creating documentation systems, with the assumption that the nature of the content - the tone of voice, the writing style - should remain essentially the same. We investigate whether the tried-and-tested technical communication writing styles from past decades still make sense today. We look at the reasons why some organisations, such as Facebook, Google & Mozilla, might be "breaking the rules" in the User Assistance they provide. We also look at how structured, adaptable, intelligent content becomes important for organisations that do decide to change.
Discovery Here, Discovery There: The Pros and Cons of Local & Remote Hosting ...Ken Varnum
Discovery systems are powerful tools to help users find information resources across the breadth of the library's online holdings. Many of these tools offer APIs for libraries to build their own user interfaces to the search index, allowing a library to keep site visitors within the library until the time they access the full text of a resource. What are the pros and cons of keeping discovery local? This talk explores the user interaction, interface design, and user expectations of such homegrown interfaces.
Download from the University of Michigan: http://hdl.handle.net/2027.42/91892
How ONIX-PL Can Help License Data Flow
Todd Carpenter, NISO; Selden Durgom Lamoureux, SDLinforms; and Ashley Bass, ProQuest
Presented at Charleston Conference 2013
Its a very nice presenttion on forest our lifeling, They are Green Lungs of the environmentso just open the presentation on i am sure u will be loving that
Are you scared of that algebraic sums? Just view this presentation an you can learn about each and every algebraic identities. Just view this and Now take full marks in your tests..
VERY ATTRACTIVE PRESENTATION CONTAINING THE FOLLOWING SLIDES: Agriculture, Crops, , Agricultural practices, Irrigation, Water logging, Weeding, Storage, Mixed Cultivation and Crop Rotation, NItrogen Fixation, Nitrogen Cycle, Animal Husbandary and many more
Explains the benefits and drawbacks of open source software. Explores various open source software used in libraries and the future of open library data.
Context, Coffee, and the Death of Crapplications: Enabling Great Global UXUltan O'Broin
Understand how and why context is king for localization, translation, and user experience alike. Find out what context of use is, and how it relates to requirements and implementation of software being used globally. Understand why translation is UX, and more. Great examples and best practices make this presentation come to life in a real way for novice, seasoned, and start up globalizers. Next time you're in Starbucks or Peets you'll remember the importance of context!
The Technical Writers Guide to Contributing to Open Source ProjectsAll Things Open
Presented by: Edidiong Asikpo, Hashnode
Presented at All Things Open 2020
Abstract: The documentation of an open source project provides an avenue for users to not only understand the project but also make contributions to it. Surveys (https://cdn2.hubspot.net/hubfs/4008838/Resources/The-2019-Tidelift-managed-open-source-survey-results.pdf) have even shown that a good documentation saves as a sign of the healthiness of an open source project.
However, technical writers still think they are not meant to contribute to open source projects because of the stereotype that only software engineers are meant to contribute to open source.
In this talk, I will introduce the audience to how technical writers can contribute to open source projects, best practices, and it’s benefits.
The changing nature of technical content (tekom tcworld 2013 conference)Ellis Pratt
There have been many developments in creating documentation systems, with the assumption that the nature of the content - the tone of voice, the writing style - should remain essentially the same. We investigate whether the tried-and-tested technical communication writing styles from past decades still make sense today. We look at the reasons why some organisations, such as Facebook, Google & Mozilla, might be "breaking the rules" in the User Assistance they provide. We also look at how structured, adaptable, intelligent content becomes important for organisations that do decide to change.
Discovery Here, Discovery There: The Pros and Cons of Local & Remote Hosting ...Ken Varnum
Discovery systems are powerful tools to help users find information resources across the breadth of the library's online holdings. Many of these tools offer APIs for libraries to build their own user interfaces to the search index, allowing a library to keep site visitors within the library until the time they access the full text of a resource. What are the pros and cons of keeping discovery local? This talk explores the user interaction, interface design, and user expectations of such homegrown interfaces.
Download from the University of Michigan: http://hdl.handle.net/2027.42/91892
How ONIX-PL Can Help License Data Flow
Todd Carpenter, NISO; Selden Durgom Lamoureux, SDLinforms; and Ashley Bass, ProQuest
Presented at Charleston Conference 2013
Case Study: We're Watching You: How and Why Researchers Study Open Source And...All Things Open
All Things Open 2014 - Day 2
Thursday, October 23rd, 2014
Dr. Megan Squire
Associate Professor of Computing Sciences with FLOSSmole Project & Elon University
Business
Case Study: We're Watching You: How and Why Researchers Study Open Source And What We've Found So Far
Trikonf 2015 - Community, Studio and the OpenExchangePaul Filkin
Presentation, with a lot of live software and website demos (not included... obviously!), delivered 11 October during the Trikonf conference in Freiburg.
When agile development first gained popularity, agile meant collocated teams, including testers, programmers, analysts, and customers who were expected to perform many functions. As agile methods have spread and expanded, many organizations with globally-distributed teams are facing challenges with their agile deployment. Having worked with many such teams, Janet Gregory has observed ways that testers in agile teams can be very productive while delivering a high-quality software product and working well with the rest of the team. In this interactive session, Janet shares her experiences and offers opportunities for all participants to discuss their specific issues and potential solutions. Whether your distributed team is scattered across time zones, has individuals working remotely from home, or is part of an offshore outsourced project, you’ll take away methods and tools to help develop open communication, deal with cultural differences, and share data and information across the miles.
A basic primer on bringing Lean Startup techniques to technical teams and organizations. Talk centered on successful integration of engineers into small, cross-functional lean startup teams. Emphasis on addressing the resulting changes in the role of the engineer.
DevOps and Testing slides at DASA ConnectKari Kakkonen
My and Rik Marselis slides at 30.5.2024 DASA Connect conference. We discuss about what is testing, then what is agile testing and finally what is Testing in DevOps. Finally we had lovely workshop with the participants trying to find out different ways to think about quality and testing in different parts of the DevOps infinity loop.
A tale of scale & speed: How the US Navy is enabling software delivery from l...sonjaschweigert1
Rapid and secure feature delivery is a goal across every application team and every branch of the DoD. The Navy’s DevSecOps platform, Party Barge, has achieved:
- Reduction in onboarding time from 5 weeks to 1 day
- Improved developer experience and productivity through actionable findings and reduction of false positives
- Maintenance of superior security standards and inherent policy enforcement with Authorization to Operate (ATO)
Development teams can ship efficiently and ensure applications are cyber ready for Navy Authorizing Officials (AOs). In this webinar, Sigma Defense and Anchore will give attendees a look behind the scenes and demo secure pipeline automation and security artifacts that speed up application ATO and time to production.
We will cover:
- How to remove silos in DevSecOps
- How to build efficient development pipeline roles and component templates
- How to deliver security artifacts that matter for ATO’s (SBOMs, vulnerability reports, and policy evidence)
- How to streamline operations with automated policy checks on container images
Generative AI Deep Dive: Advancing from Proof of Concept to ProductionAggregage
Join Maher Hanafi, VP of Engineering at Betterworks, in this new session where he'll share a practical framework to transform Gen AI prototypes into impactful products! He'll delve into the complexities of data collection and management, model selection and optimization, and ensuring security, scalability, and responsible use.
Sudheer Mechineni, Head of Application Frameworks, Standard Chartered Bank
Discover how Standard Chartered Bank harnessed the power of Neo4j to transform complex data access challenges into a dynamic, scalable graph database solution. This keynote will cover their journey from initial adoption to deploying a fully automated, enterprise-grade causal cluster, highlighting key strategies for modelling organisational changes and ensuring robust disaster recovery. Learn how these innovations have not only enhanced Standard Chartered Bank’s data infrastructure but also positioned them as pioneers in the banking sector’s adoption of graph technology.
Communications Mining Series - Zero to Hero - Session 1DianaGray10
This session provides introduction to UiPath Communication Mining, importance and platform overview. You will acquire a good understand of the phases in Communication Mining as we go over the platform with you. Topics covered:
• Communication Mining Overview
• Why is it important?
• How can it help today’s business and the benefits
• Phases in Communication Mining
• Demo on Platform overview
• Q/A
Climate Impact of Software Testing at Nordic Testing DaysKari Kakkonen
My slides at Nordic Testing Days 6.6.2024
Climate impact / sustainability of software testing discussed on the talk. ICT and testing must carry their part of global responsibility to help with the climat warming. We can minimize the carbon footprint but we can also have a carbon handprint, a positive impact on the climate. Quality characteristics can be added with sustainability, and then measured continuously. Test environments can be used less, and in smaller scale and on demand. Test techniques can be used in optimizing or minimizing number of tests. Test automation can be used to speed up testing.
GraphRAG is All You need? LLM & Knowledge GraphGuy Korland
Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs.
1. Unifying Large Language Models and Knowledge Graphs: A Roadmap.
https://arxiv.org/abs/2306.08302
2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs:
https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/
Dr. Sean Tan, Head of Data Science, Changi Airport Group
Discover how Changi Airport Group (CAG) leverages graph technologies and generative AI to revolutionize their search capabilities. This session delves into the unique search needs of CAG’s diverse passengers and customers, showcasing how graph data structures enhance the accuracy and relevance of AI-generated search results, mitigating the risk of “hallucinations” and improving the overall customer journey.
Why You Should Replace Windows 11 with Nitrux Linux 3.5.0 for enhanced perfor...SOFTTECHHUB
The choice of an operating system plays a pivotal role in shaping our computing experience. For decades, Microsoft's Windows has dominated the market, offering a familiar and widely adopted platform for personal and professional use. However, as technological advancements continue to push the boundaries of innovation, alternative operating systems have emerged, challenging the status quo and offering users a fresh perspective on computing.
One such alternative that has garnered significant attention and acclaim is Nitrux Linux 3.5.0, a sleek, powerful, and user-friendly Linux distribution that promises to redefine the way we interact with our devices. With its focus on performance, security, and customization, Nitrux Linux presents a compelling case for those seeking to break free from the constraints of proprietary software and embrace the freedom and flexibility of open-source computing.
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...James Anderson
Effective Application Security in Software Delivery lifecycle using Deployment Firewall and DBOM
The modern software delivery process (or the CI/CD process) includes many tools, distributed teams, open-source code, and cloud platforms. Constant focus on speed to release software to market, along with the traditional slow and manual security checks has caused gaps in continuous security as an important piece in the software supply chain. Today organizations feel more susceptible to external and internal cyber threats due to the vast attack surface in their applications supply chain and the lack of end-to-end governance and risk management.
The software team must secure its software delivery process to avoid vulnerability and security breaches. This needs to be achieved with existing tool chains and without extensive rework of the delivery processes. This talk will present strategies and techniques for providing visibility into the true risk of the existing vulnerabilities, preventing the introduction of security issues in the software, resolving vulnerabilities in production environments quickly, and capturing the deployment bill of materials (DBOM).
Speakers:
Bob Boule
Robert Boule is a technology enthusiast with PASSION for technology and making things work along with a knack for helping others understand how things work. He comes with around 20 years of solution engineering experience in application security, software continuous delivery, and SaaS platforms. He is known for his dynamic presentations in CI/CD and application security integrated in software delivery lifecycle.
Gopinath Rebala
Gopinath Rebala is the CTO of OpsMx, where he has overall responsibility for the machine learning and data processing architectures for Secure Software Delivery. Gopi also has a strong connection with our customers, leading design and architecture for strategic implementations. Gopi is a frequent speaker and well-known leader in continuous delivery and integrating security into software delivery.
The Art of the Pitch: WordPress Relationships and SalesLaura Byrne
Clients don’t know what they don’t know. What web solutions are right for them? How does WordPress come into the picture? How do you make sure you understand scope and timeline? What do you do if sometime changes?
All these questions and more will be explored as we talk about matching clients’ needs with what your agency offers without pulling teeth or pulling your hair out. Practical tips, and strategies for successful relationship building that leads to closing the deal.
Goodbye Windows 11: Make Way for Nitrux Linux 3.5.0!SOFTTECHHUB
As the digital landscape continually evolves, operating systems play a critical role in shaping user experiences and productivity. The launch of Nitrux Linux 3.5.0 marks a significant milestone, offering a robust alternative to traditional systems such as Windows 11. This article delves into the essence of Nitrux Linux 3.5.0, exploring its unique features, advantages, and how it stands as a compelling choice for both casual users and tech enthusiasts.
UiPath Test Automation using UiPath Test Suite series, part 5DianaGray10
Welcome to UiPath Test Automation using UiPath Test Suite series part 5. In this session, we will cover CI/CD with devops.
Topics covered:
CI/CD with in UiPath
End-to-end overview of CI/CD pipeline with Azure devops
Speaker:
Lyndsey Byblow, Test Suite Sales Engineer @ UiPath, Inc.
UiPath Test Automation using UiPath Test Suite series, part 5
Taking Documentation to the Next Level in Young Software Projects
1. Taking Documentation to the Next Level
in Young Software Projects
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
2. Do you contribute to documentation?
Have you created a web page, blog posting,
webinar, video, etc. about a software project?
Have you answered a question on a mailing list
or forum?
Have you asked a question on a mailing list or
forum?
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
3. Structure of this talk
Problems of documentation in young software
projects
Some research into the use of mailing lists and
discussion forums
Comments about online Erlang documentation
Suggestions for developing more and better
documentation
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
4. Documentation and the adoption curve
Innovators Early Adopters
Mainstream success
Documentation
needed
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
Publishers (best case)
Decline
Publishers (worst case)
5. Documentation by the innovators
Software developers tend to write for other
people like themselves
Assume deep background knowledge that can
be transferred to their project
Elements of innovator documentation
Architectural justifications
Comparisons to other projects
Quick-starts
Reference material
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
6. Example: Riak documentation
Focuses on architecture
Useful to distinguish Riak from similar projects
But does not connect architecture to use cases
to make the information practical
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
7. Early adopters arrive
They possess enough background to use
innovators' documentation
Consider documentation adequate
Promote project and generate enthusiasm that
draws other users
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
8. Mainstream users arrive
Confused and alienated by the documentation
Desperately search for help, which may or may
not arrive
Leave project if not engaged and aided
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
9. Research on mailing lists
Used on every project
Easy to quantify results
Every question reflects a failure at documentation
Perhaps the feature is undocumented
Perhaps the documentation could not be found
Perhaps the documentation didn't seem
relevant to the question
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
10. Questions asked about mailing lists
How many technical questions get answered?
How long does it take to get an answer?
How much noise is on the thread?
http://praxagora.com/andyo/professional/mailing_list/mailing_list.html
http://www.praxagora.com/andyo/professional/mailing_list_follow_up
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
11. How many questions were answered?
Unanswered
7
7
7
5
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
Answered
Fedora Linux
7
Ubuntu Linux
7
Rails
7
Perl
9
12. So, are mailing lists effective?
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
13. How is Erlang documentation?
Erlang is in a lucky position
It is not a young project
It has been able to develop innumerable
training materials over the decades
Several publishers have released
professional books
Functional principles have spread
throughout the programming field
One must consider the whole information
ecosystem
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
14. Comments on erlang.org
Site is run by Ericsson
Potentially backed by lots of resources
But how much attention does the company
give it?
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
16. Assumptions in documentation
Reader understands the math
Reader understands the notion of recursion
Reader has seen factorials used as an example
of recursive programming
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
17. Focusing on the code
Reader must be able to pick out “active ingredients”
in code
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
18. Focusing on the executable code
Reader must determine when and why each
function runs
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
20. Questions left by course
Why does Erlang offer both tuples and lists?
Do tuples and lists work like they do in other
languages?
When do you use a tuple and when do you use
a list?
Other lapses in course: unexplained syntax, isolated
examples that don't build on each other, etc.
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
21. Comments on erlangcentral.org
Site run by the Industrial Erlang User Group
Points to wide range of documents and other sites
Solicits user contributions to wiki
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
22. Criteria for evaluating documentation
Availability—does it exist at all?
Findability—can readers get answers?
Quality—accuracy, readability, relevance, etc.
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
23. Availability—try crowdsourcing
Your developers don't have time to write
everything
Users have innate sympathy for other users
They'll generate content anyway, so you can
coordinate it intelligently
Give up on “One Ring to Rule Them All”
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
24. Crowdsourcing has a history
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
26. Mobilizing users for documentation
Search for bloggers, contributors to forums
External motivations can encourage contributions
Access to developers is a motivation
Don't strive for unity—embrace multivocality
Let people use their own favorite media
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
29. FLOSS Manuals—sprints
Bring volunteers together in one space
Usually sponsored by an open source project
Google has hosted many documentation sprints
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
30. Findability—more than a search engine
Add boxes for people to recommend documents
“Read before this document”
“Read after this document”
Long-term goal: spider creates recommended
paths through documents
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
31. Quality—What's the ultimate goal?
After reading the document, can the reader
accomplish the task she set out to do?
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
32. Quality—A/B testing
Attach a quiz to a document
As you rewrite the document, check how well
the readers can answer the quiz
Remember: a user experience encompasses more
than one document
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media
33. Summary
Documentation and training materials are crucial
to mainstream adoption of young projects
A serious need exists for better documentation
Invest special efforts to create documentation,
make it findable, and improve its quality
Erlang Factory, 23 October 2013
Andy Oram, O'Reilly Media