Sample code and documentation are important when engaging a developer audience, but what are the guidelines? How can you maintain consistent tone across languages, platforms, and levels of developer experience? We'll compare some leading developer documentation sites and discuss strategies for keeping documentation and sample code content consistent, comprehensive, and concise.
Engaging a Developer Audience: Documentation and MoreAnya Stettler
Sample code and documentation are important when engaging a developer audience, but what are the guidelines? How can you maintain consistent tone across languages, platforms, and levels of developer experience? We'll compare some leading developer documentation sites and discuss strategies for keeping documentation and sample code content consistent, comprehensive, and concise.
Documenting APIs: Sample Code and More (with many pictures of cats)Anya Stettler
The document discusses what constitutes good API documentation and provides examples. It argues that good documentation includes technical references, code snippets, tutorials, application samples, and Q&A resources. It also notes that top APIs offer many of these elements, and that while comprehensive documentation is ideal, it also needs to be concise and accessible.
Importance of PHP Assignment Help ExpertsLisa Miller
To complete a PHP assignment accurately for scoring high marks, the importance of PHP assignment help experts is immense. Know the importance of PHP assignment help experts and hire them if you need.
Selfish Accessibility — WordCamp Europe 2017Adrian Roselli
We can all pretend that we’re helping others by making web sites and software accessible, but we are really making them better for our future selves. Learn some fundamentals of accessibility and how it can benefit you (whether future you from aging or you after something else limits your abilities). We’ll review simple testing techniques, basic features and enhancements, coming trends, and where to get help. This isn’t intended to be a deep dive, but more of an overall primer for those who aren’t sure where to start nor how it helps them.
The document discusses lesser known tools that can help with computer science and engineering assignments. It describes tools for website development and testing like Bounce and CodePen. General tools mentioned include Coderwall for coding tips and LastPass for password management. Learning resources highlighted are dictionaries of data structures and algorithms, cheat sheets, open online courses, and Stack Overflow for coding help. The document encourages students to make use of these free and paid tools and online sources for assignments.
The document discusses how libraries can use mobile technology and QR codes to provide services to patrons on their mobile devices. It recommends creating a mobile-friendly website using WordPress with plugins and themes to make content accessible from any device. QR codes can link patrons to the mobile site, research guides, ebooks and other digital content. Formatting documents as ebooks allows easier reading on phones and tablets. The goal is to meet patrons "halfway" by using technologies they already have to provide library services wherever patrons are.
Engaging a Developer Audience: Documentation and MoreAnya Stettler
Sample code and documentation are important when engaging a developer audience, but what are the guidelines? How can you maintain consistent tone across languages, platforms, and levels of developer experience? We'll compare some leading developer documentation sites and discuss strategies for keeping documentation and sample code content consistent, comprehensive, and concise.
Documenting APIs: Sample Code and More (with many pictures of cats)Anya Stettler
The document discusses what constitutes good API documentation and provides examples. It argues that good documentation includes technical references, code snippets, tutorials, application samples, and Q&A resources. It also notes that top APIs offer many of these elements, and that while comprehensive documentation is ideal, it also needs to be concise and accessible.
Importance of PHP Assignment Help ExpertsLisa Miller
To complete a PHP assignment accurately for scoring high marks, the importance of PHP assignment help experts is immense. Know the importance of PHP assignment help experts and hire them if you need.
Selfish Accessibility — WordCamp Europe 2017Adrian Roselli
We can all pretend that we’re helping others by making web sites and software accessible, but we are really making them better for our future selves. Learn some fundamentals of accessibility and how it can benefit you (whether future you from aging or you after something else limits your abilities). We’ll review simple testing techniques, basic features and enhancements, coming trends, and where to get help. This isn’t intended to be a deep dive, but more of an overall primer for those who aren’t sure where to start nor how it helps them.
The document discusses lesser known tools that can help with computer science and engineering assignments. It describes tools for website development and testing like Bounce and CodePen. General tools mentioned include Coderwall for coding tips and LastPass for password management. Learning resources highlighted are dictionaries of data structures and algorithms, cheat sheets, open online courses, and Stack Overflow for coding help. The document encourages students to make use of these free and paid tools and online sources for assignments.
The document discusses how libraries can use mobile technology and QR codes to provide services to patrons on their mobile devices. It recommends creating a mobile-friendly website using WordPress with plugins and themes to make content accessible from any device. QR codes can link patrons to the mobile site, research guides, ebooks and other digital content. Formatting documents as ebooks allows easier reading on phones and tablets. The goal is to meet patrons "halfway" by using technologies they already have to provide library services wherever patrons are.
This document discusses clean code principles and provides an example of refactoring code to be cleaner. Clean code is written by someone who cares and treats it as an art, paying attention to details. It is focused, not redundant, pleasant to read, easily extended, keeps methods and classes small. The document provides an example of refactoring code over multiple iterations to use better names, formatting and comments following principles like single responsibility. It emphasizes good naming conventions, formatting, comments and coding standards to write clean, understandable code.
This document discusses various anti-patterns that can occur in software engineering projects and how to overcome them. It describes three main anti-patterns: analysis paralysis, where too much time is spent analyzing instead of taking action; design by committee, where too many designers are involved without clear leadership or vision; and reinventing the square wheel, where existing solutions are ignored in favor of custom solutions. It then discusses how adopting principles of mastery, autonomy and purpose at an organization can help overcome anti-patterns by promoting continual learning, self-directed work, and alignment with organizational goals.
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
This document discusses the importance of comments in code. It provides reasons to include comments such as explaining unintuitive code, documenting what the code is doing, and documenting why certain approaches were taken. It also discusses what makes a good comment, including commenting on processing, APIs, changes, tags, and keywords like TODO, FIXME, and XXX. Bad commenting practices like redundant comments are also covered. The document recommends commenting code for other programmers and notes comments are also important for documentation standards like JavaDoc and PHPDoc.
A quick introduction on code standards, documentation and testing for first year grading students. Very incomplete and opinionated. Still fun and interesting, I hope!
This document outlines the work experience of Pacharakhunthai as a project coordinator and manager from March 2015 to March 2016. It lists several projects for clients such as Makro, Dell, Kasikorn Bank coordinating with teams, graphic designers, and suppliers. The responsibilities included coordinating seminars, online shopping zones, registration areas, and standard booth suppliers.
This document discusses code documentation. It defines key terms like code and documentation. It explains the importance of documenting code for future use and collaboration. It outlines different types of documentation like requirements documentation, commenting code, markdown files, and end-user documentation. It provides details on commenting code with inline and descriptive comments. It describes what information a README file should include. Finally, it concludes that properly documenting code makes debugging and collaboration easier.
To document or not to document? An exploratory study on developers' motivatio...Hayim Makabee
This document summarizes a study on developers' motivation to document code. Through interviews and surveys, researchers identified hindering and motivating factors for code documentation. Hindering factors included documentation being tedious, difficult, time-consuming, and interrupting coding work. Motivating factors included documentation improving code comprehensibility, order, and quality. The researchers propose designing a solution to encourage documentation by emphasizing motivating factors and mitigating hindering ones. They plan to further validate findings through a quantitative questionnaire. The goal is to increase developers' internal motivation to document code.
Jennifer Rondeau and Margaret Eker presentation from Write The Docs Prague, 2016:
Treating docs as code, an approach that more and more teams and companies are moving toward, involves more than putting the two together in a source repository. We discuss some of the details that often get lost in as dev and docs learn to work together in new ways. Because if all we do is put doc files next to code files in source control, or use parts of the same workflow for code and docs, we're still isolating docs as a separate sort of responsibility, free from the obligations of systematic review and testing without which code would never be accepted into production.
Thinking of Documentation as Code [YUIConf 2013]evangoer
As a software engineer, one of the best things you can do for your documentation is to take the principles of code construction that you already know and apply them to your writing. We'll demonstrate how thinking about documentation as code will help you avoid many of the classic high level mistakes people make when launching documentation projects. This is a companion piece to last year's talk, which focused on how to optimize English prose at the micro level.
Delivering High-Velocity Docs that Keep Pace with Rapid Release CyclesRachel Whitton
This document discusses delivering documentation that keeps pace with rapid software release cycles. It recommends establishing trust in the documentation delivery process by increasing project visibility through centralized workflows, open collaboration, and dependable notifications. It also suggests simplifying peer reviews by prioritizing the contributor experience. Finally, it advocates automating grunt work like building, publishing, deploying, and testing documentation to create a reliable and repeatable documentation delivery process.
Presentations from our osAccelerate event in London UK by Mark Brincat, CTO of The Economist and Steve Tanner, Systems Analyst at the World Trade Organisation.
Keynote- We're going wrong: Choosing the web's future. Peter Paul KochFuture Insights
From FOWA London 2015
Web developers and browser vendors are trying too hard to emulate native apps; in vain, PPK says, because we can't out-native native. Meanwhile this quest for native emulation has a host of undesirable by-effects: too many new browser features that need too many new (and not always performant) tools to create polyfills, which cause too many people to think they only need to understand the tools in order to be a web developer. We're going wrong. We should take some time to figure out what the web is for, how we can have a successful web ecosystem next to, but not in competition with, native ecosystems, and how we should explain what web development is to Java developers and others who come from a non-web background. We need time to think.
Using Web 2.0 Tools inside Brightspace with an Eye on AccessibilityD2L
Learn about the use of free web applications inside Brightspace and find those that can be used effectively in an education environment. Discover at least four popular Web 2.0 tools that create significant accessibility barriers to students with disabilities, and about the techniques needed for creating alternative assignments or work-arounds for students who are unable to utilize inaccessible Web 2.0 tools.
Watch the webinar here: http://bit.ly/1McZHr2
Richard Morgan, What is your museum good at and how do you build an API for it?museums and the web
A presentation from Museums and the Web 2009.
There has been an encouraging surge of interest in the museums sector in opening up museum data and building APIs on museum collections databases. However, a museum's collections are not the only and sometimes not even the most interesting service which a museum provides. Events, communities, shopping, learning and interpretation are all areas where museums have lively and engaging offerings. These areas typically have a Web presence, and therefore the possibility exists to build an API or make use of an existing API to open up that offering.
Furthermore, as museum collections’ content becomes more readily accessible on the Web, museums need to focus more and more on their value-add, the expertise and authority which they bring to the interpretation of their own collections and those of others.
Mini-Workshop: APIs- how and why [Mini-Workshop]
One of the greatest challenges to developing an API is ensuring that your API lasts. After all, you don’t want to have to release and manage multiple versions of your API just because you weren’t expecting users to use it a certain way, or because you didn’t anticipate far enough down the roadmap. In this session, we’ll talk about the challenge of API Longevity, as well as ways to increase your API lifecycle including having a proper mindset, careful design, agile user experience and prototyping, best design practices including hypermedia, and the challenge of maintaining persistence.
Towards an Agile Authoring methodology: Learning from LeanEllis Pratt
This document discusses applying Lean principles to technical writing in an Agile environment. It defines Lean and Agile, then identifies types of waste that can occur in documentation, such as unnecessary content, rework, and delays. The author advocates for technical writers to be integrated team members, treating documentation like code and adopting Agile practices like sprints and iterative publishing. Embracing Lean concepts like identifying value, optimizing workflows, and addressing problems collaboratively can help technical communicators address challenges of Agile and minimize documentation waste.
Twin Redheaded Stepchildren of a Different Mother: The Usability of Accessibi...Dylan Wilbanks
This document summarizes a presentation given by Michael Fienen and Dylan Wilbanks on the topic of accessibility and usability. The presentation argues that accessibility and usability have many similarities and should be considered together from the beginning of a project. It provides recommendations for making templates, forms, and videos accessible. It also discusses testing for accessibility and strategies for getting buy-in for accessibility within an organization, emphasizing an early and iterative approach. The overall message is that accessibility should be a priority from the start of any project to create a better experience for all users.
This document discusses clean code principles and provides an example of refactoring code to be cleaner. Clean code is written by someone who cares and treats it as an art, paying attention to details. It is focused, not redundant, pleasant to read, easily extended, keeps methods and classes small. The document provides an example of refactoring code over multiple iterations to use better names, formatting and comments following principles like single responsibility. It emphasizes good naming conventions, formatting, comments and coding standards to write clean, understandable code.
This document discusses various anti-patterns that can occur in software engineering projects and how to overcome them. It describes three main anti-patterns: analysis paralysis, where too much time is spent analyzing instead of taking action; design by committee, where too many designers are involved without clear leadership or vision; and reinventing the square wheel, where existing solutions are ignored in favor of custom solutions. It then discusses how adopting principles of mastery, autonomy and purpose at an organization can help overcome anti-patterns by promoting continual learning, self-directed work, and alignment with organizational goals.
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
This document discusses the importance of comments in code. It provides reasons to include comments such as explaining unintuitive code, documenting what the code is doing, and documenting why certain approaches were taken. It also discusses what makes a good comment, including commenting on processing, APIs, changes, tags, and keywords like TODO, FIXME, and XXX. Bad commenting practices like redundant comments are also covered. The document recommends commenting code for other programmers and notes comments are also important for documentation standards like JavaDoc and PHPDoc.
A quick introduction on code standards, documentation and testing for first year grading students. Very incomplete and opinionated. Still fun and interesting, I hope!
This document outlines the work experience of Pacharakhunthai as a project coordinator and manager from March 2015 to March 2016. It lists several projects for clients such as Makro, Dell, Kasikorn Bank coordinating with teams, graphic designers, and suppliers. The responsibilities included coordinating seminars, online shopping zones, registration areas, and standard booth suppliers.
This document discusses code documentation. It defines key terms like code and documentation. It explains the importance of documenting code for future use and collaboration. It outlines different types of documentation like requirements documentation, commenting code, markdown files, and end-user documentation. It provides details on commenting code with inline and descriptive comments. It describes what information a README file should include. Finally, it concludes that properly documenting code makes debugging and collaboration easier.
To document or not to document? An exploratory study on developers' motivatio...Hayim Makabee
This document summarizes a study on developers' motivation to document code. Through interviews and surveys, researchers identified hindering and motivating factors for code documentation. Hindering factors included documentation being tedious, difficult, time-consuming, and interrupting coding work. Motivating factors included documentation improving code comprehensibility, order, and quality. The researchers propose designing a solution to encourage documentation by emphasizing motivating factors and mitigating hindering ones. They plan to further validate findings through a quantitative questionnaire. The goal is to increase developers' internal motivation to document code.
Jennifer Rondeau and Margaret Eker presentation from Write The Docs Prague, 2016:
Treating docs as code, an approach that more and more teams and companies are moving toward, involves more than putting the two together in a source repository. We discuss some of the details that often get lost in as dev and docs learn to work together in new ways. Because if all we do is put doc files next to code files in source control, or use parts of the same workflow for code and docs, we're still isolating docs as a separate sort of responsibility, free from the obligations of systematic review and testing without which code would never be accepted into production.
Thinking of Documentation as Code [YUIConf 2013]evangoer
As a software engineer, one of the best things you can do for your documentation is to take the principles of code construction that you already know and apply them to your writing. We'll demonstrate how thinking about documentation as code will help you avoid many of the classic high level mistakes people make when launching documentation projects. This is a companion piece to last year's talk, which focused on how to optimize English prose at the micro level.
Delivering High-Velocity Docs that Keep Pace with Rapid Release CyclesRachel Whitton
This document discusses delivering documentation that keeps pace with rapid software release cycles. It recommends establishing trust in the documentation delivery process by increasing project visibility through centralized workflows, open collaboration, and dependable notifications. It also suggests simplifying peer reviews by prioritizing the contributor experience. Finally, it advocates automating grunt work like building, publishing, deploying, and testing documentation to create a reliable and repeatable documentation delivery process.
Presentations from our osAccelerate event in London UK by Mark Brincat, CTO of The Economist and Steve Tanner, Systems Analyst at the World Trade Organisation.
Keynote- We're going wrong: Choosing the web's future. Peter Paul KochFuture Insights
From FOWA London 2015
Web developers and browser vendors are trying too hard to emulate native apps; in vain, PPK says, because we can't out-native native. Meanwhile this quest for native emulation has a host of undesirable by-effects: too many new browser features that need too many new (and not always performant) tools to create polyfills, which cause too many people to think they only need to understand the tools in order to be a web developer. We're going wrong. We should take some time to figure out what the web is for, how we can have a successful web ecosystem next to, but not in competition with, native ecosystems, and how we should explain what web development is to Java developers and others who come from a non-web background. We need time to think.
Using Web 2.0 Tools inside Brightspace with an Eye on AccessibilityD2L
Learn about the use of free web applications inside Brightspace and find those that can be used effectively in an education environment. Discover at least four popular Web 2.0 tools that create significant accessibility barriers to students with disabilities, and about the techniques needed for creating alternative assignments or work-arounds for students who are unable to utilize inaccessible Web 2.0 tools.
Watch the webinar here: http://bit.ly/1McZHr2
Richard Morgan, What is your museum good at and how do you build an API for it?museums and the web
A presentation from Museums and the Web 2009.
There has been an encouraging surge of interest in the museums sector in opening up museum data and building APIs on museum collections databases. However, a museum's collections are not the only and sometimes not even the most interesting service which a museum provides. Events, communities, shopping, learning and interpretation are all areas where museums have lively and engaging offerings. These areas typically have a Web presence, and therefore the possibility exists to build an API or make use of an existing API to open up that offering.
Furthermore, as museum collections’ content becomes more readily accessible on the Web, museums need to focus more and more on their value-add, the expertise and authority which they bring to the interpretation of their own collections and those of others.
Mini-Workshop: APIs- how and why [Mini-Workshop]
One of the greatest challenges to developing an API is ensuring that your API lasts. After all, you don’t want to have to release and manage multiple versions of your API just because you weren’t expecting users to use it a certain way, or because you didn’t anticipate far enough down the roadmap. In this session, we’ll talk about the challenge of API Longevity, as well as ways to increase your API lifecycle including having a proper mindset, careful design, agile user experience and prototyping, best design practices including hypermedia, and the challenge of maintaining persistence.
Towards an Agile Authoring methodology: Learning from LeanEllis Pratt
This document discusses applying Lean principles to technical writing in an Agile environment. It defines Lean and Agile, then identifies types of waste that can occur in documentation, such as unnecessary content, rework, and delays. The author advocates for technical writers to be integrated team members, treating documentation like code and adopting Agile practices like sprints and iterative publishing. Embracing Lean concepts like identifying value, optimizing workflows, and addressing problems collaboratively can help technical communicators address challenges of Agile and minimize documentation waste.
Twin Redheaded Stepchildren of a Different Mother: The Usability of Accessibi...Dylan Wilbanks
This document summarizes a presentation given by Michael Fienen and Dylan Wilbanks on the topic of accessibility and usability. The presentation argues that accessibility and usability have many similarities and should be considered together from the beginning of a project. It provides recommendations for making templates, forms, and videos accessible. It also discusses testing for accessibility and strategies for getting buy-in for accessibility within an organization, emphasizing an early and iterative approach. The overall message is that accessibility should be a priority from the start of any project to create a better experience for all users.
API Developer Experience: Why it Matters, and How Documenting Your API with S...SmartBear
Whether you’re new to Swagger, or have already been using the framework for API design, there’s a good chance you still have questions about how to improve your API documentation. Creating API documentation your consumers will love can take some work, but the investment will have a significant payoff in the form of a great developer experience, easier implementation, and improved adoption of your API.
This presentation covers good developer experience in detail, focusing on why and how to provide an optimal experience for developers using your API. We will also cover how Swagger has changed the API design and documentation landscape, and finally show some good practices for API documentation using Swagger in SwaggerHub’s integrated API development platform.
Things to expect in this webinar:
What is Developer Experience (DX)?
What does it mean for an API to have good DX?
API documentation in the context of good DX?
An introduction to the Swagger framework
Designing APIs from a usability perspective using Swagger and SwaggerHub
Presentation for the Iowa Small Libraries online conference in January 2010 covering strategies for libraries in difficult economic times: project management, project assessment, marketing strategies, and free web tools & software to save libraries money.
Byg Tilgængeligt - Build Accessibly. My presentation for Community Day 2012 on 10 May 2012. Communityday.dk - for developers. Download file to get all the great tips and links in the notes.
The document provides an overview of prototyping accessibility for a workshop presentation. It includes instructions for group exercises to prototype user interface elements and develop personas. It also covers various accessibility topics like disability types, user experience models, technical accessibility standards around text alternatives, typography, links, color contrast, labeling fields, document structure, and keyboard/screen reader support. The goal is to educate attendees on inclusive design practices through hands-on exercises and discussions.
This document discusses different approaches to prototyping including storyboards, paper prototypes, printouts, swipeable photo galleries, presentations, and native code. It emphasizes that prototyping allows involving users to refine usability and communicate value to stakeholders. Different types of prototypes are suited to different purposes like brainstorming, proof of concept, or user testing. Rapid prototyping approaches include creating mock-ups, getting user feedback, and iterating. Prototyping is especially important for mobile due to screen flows and animations across devices. Workshops, hackathons, and hack days are approaches that can bring together teams to quickly create prototypes.
Prototyping Accessibility - WordCamp Europe 2018Adrian Roselli
Learn some fundamentals of accessibility and how it can benefit you (whether future you from aging or you after something else limits your abilities). We’ll review differing abilities, generate (minimal) user stories and personas, discuss best practices for design and development, prototype some ideas (on paper), and discuss where to get help. This isn’t intended to be a deep dive into technologies, but more of an overall primer for those who aren’t sure where to start with accessibility nor how it helps them.
The document provides information and advice for speakers about presenting at conferences. It includes tips for selecting topics, writing proposals and bios, preparing presentations, and delivering talks. The document suggests rehearsing extensively, tailoring talks for the audience, and focusing on storytelling. Hands-on sections allow attendees to practice selecting topics, writing proposals and bios, and delivering short presentations for feedback. The next speaker academy session will be planned for September/October.
Web Accessibility Top 10 - LCC (1/2 day workshop, August 2013)Carrie Anton
A half day workshop walks people through common accessibility issues on the web, including good reasons why to accessible. Great for web designers, developers, teachers and IT trainers.
Introduction to GraphQL (or How I Learned to Stop Worrying about REST APIs)Hafiz Ismail
Talk for FOSSASIA 2016 (http://2016.fossasia.org)
----
This talk will give a brief and enlightening look into how GraphQL can help you address common weaknesses that you, as a web / mobile developer, would normally face with using / building typical REST API systems.
Let's stop fighting about whether we should implement the strictest interpretation of REST or how pragmatic REST-ful design is the only way to go, or debate about what REST is or what it should be.
A couple of demos (In Golang! Yay!) will be shown that are guaranteed to open up your eyes and see that the dawn of liberation for product developers is finally here.
Background: GraphQL is a data query language and runtime designed and used at Facebook to request and deliver data to mobile and web apps since 2012.
Hafiz Ismail (@sogko) is a contributor to Go / Golang implementation of GraphQL server library (https://github.com/graphql-go/graphql) and is looking to encourage fellow developers to join in the collaborative effort.
This document discusses key concepts around usability, accessibility, and professional practices for web development. It defines usability as how easy a website is to use and emphasizes the importance of considering the intended audience. Accessibility involves measures to make websites usable for people with disabilities. Professional practices include following web standards, validating code, testing websites thoroughly, and keeping up-to-date with developments in the field through publications and mailing lists.
What is Augmented Reality Image Trackingpavan998932
Augmented Reality (AR) Image Tracking is a technology that enables AR applications to recognize and track images in the real world, overlaying digital content onto them. This enhances the user's interaction with their environment by providing additional information and interactive elements directly tied to physical images.
Neo4j - Product Vision and Knowledge Graphs - GraphSummit ParisNeo4j
Dr. Jesús Barrasa, Head of Solutions Architecture for EMEA, Neo4j
Découvrez les dernières innovations de Neo4j, et notamment les dernières intégrations cloud et les améliorations produits qui font de Neo4j un choix essentiel pour les développeurs qui créent des applications avec des données interconnectées et de l’IA générative.
GraphSummit Paris - The art of the possible with Graph TechnologyNeo4j
Sudhir Hasbe, Chief Product Officer, Neo4j
Join us as we explore breakthrough innovations enabled by interconnected data and AI. Discover firsthand how organizations use relationships in data to uncover contextual insights and solve our most pressing challenges – from optimizing supply chains, detecting fraud, and improving customer experiences to accelerating drug discoveries.
Quarkus Hidden and Forbidden ExtensionsMax Andersen
Quarkus has a vast extension ecosystem and is known for its subsonic and subatomic feature set. Some of these features are not as well known, and some extensions are less talked about, but that does not make them less interesting - quite the opposite.
Come join this talk to see some tips and tricks for using Quarkus and some of the lesser known features, extensions and development techniques.
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI AppGoogle
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI App
👉👉 Click Here To Get More Info 👇👇
https://sumonreview.com/ai-fusion-buddy-review
AI Fusion Buddy Review: Key Features
✅Create Stunning AI App Suite Fully Powered By Google's Latest AI technology, Gemini
✅Use Gemini to Build high-converting Converting Sales Video Scripts, ad copies, Trending Articles, blogs, etc.100% unique!
✅Create Ultra-HD graphics with a single keyword or phrase that commands 10x eyeballs!
✅Fully automated AI articles bulk generation!
✅Auto-post or schedule stunning AI content across all your accounts at once—WordPress, Facebook, LinkedIn, Blogger, and more.
✅With one keyword or URL, generate complete websites, landing pages, and more…
✅Automatically create & sell AI content, graphics, websites, landing pages, & all that gets you paid non-stop 24*7.
✅Pre-built High-Converting 100+ website Templates and 2000+ graphic templates logos, banners, and thumbnail images in Trending Niches.
✅Say goodbye to wasting time logging into multiple Chat GPT & AI Apps once & for all!
✅Save over $5000 per year and kick out dependency on third parties completely!
✅Brand New App: Not available anywhere else!
✅ Beginner-friendly!
✅ZERO upfront cost or any extra expenses
✅Risk-Free: 30-Day Money-Back Guarantee!
✅Commercial License included!
See My Other Reviews Article:
(1) AI Genie Review: https://sumonreview.com/ai-genie-review
(2) SocioWave Review: https://sumonreview.com/sociowave-review
(3) AI Partner & Profit Review: https://sumonreview.com/ai-partner-profit-review
(4) AI Ebook Suite Review: https://sumonreview.com/ai-ebook-suite-review
#AIFusionBuddyReview,
#AIFusionBuddyFeatures,
#AIFusionBuddyPricing,
#AIFusionBuddyProsandCons,
#AIFusionBuddyTutorial,
#AIFusionBuddyUserExperience
#AIFusionBuddyforBeginners,
#AIFusionBuddyBenefits,
#AIFusionBuddyComparison,
#AIFusionBuddyInstallation,
#AIFusionBuddyRefundPolicy,
#AIFusionBuddyDemo,
#AIFusionBuddyMaintenanceFees,
#AIFusionBuddyNewbieFriendly,
#WhatIsAIFusionBuddy?,
#HowDoesAIFusionBuddyWorks
Software Engineering, Software Consulting, Tech Lead, Spring Boot, Spring Cloud, Spring Core, Spring JDBC, Spring Transaction, Spring MVC, OpenShift Cloud Platform, Kafka, REST, SOAP, LLD & HLD.
E-commerce Application Development Company.pdfHornet Dynamics
Your business can reach new heights with our assistance as we design solutions that are specifically appropriate for your goals and vision. Our eCommerce application solutions can digitally coordinate all retail operations processes to meet the demands of the marketplace while maintaining business continuity.
Mobile app Development Services | Drona InfotechDrona Infotech
Drona Infotech is one of the Best Mobile App Development Company In Noida Maintenance and ongoing support. mobile app development Services can help you maintain and support your app after it has been launched. This includes fixing bugs, adding new features, and keeping your app up-to-date with the latest
Visit Us For :
Takashi Kobayashi and Hironori Washizaki, "SWEBOK Guide and Future of SE Education," First International Symposium on the Future of Software Engineering (FUSE), June 3-6, 2024, Okinawa, Japan
Neo4j - Product Vision and Knowledge Graphs - GraphSummit ParisNeo4j
Dr. Jesús Barrasa, Head of Solutions Architecture for EMEA, Neo4j
Découvrez les dernières innovations de Neo4j, et notamment les dernières intégrations cloud et les améliorations produits qui font de Neo4j un choix essentiel pour les développeurs qui créent des applications avec des données interconnectées et de l’IA générative.
Why Mobile App Regression Testing is Critical for Sustained Success_ A Detail...kalichargn70th171
A dynamic process unfolds in the intricate realm of software development, dedicated to crafting and sustaining products that effortlessly address user needs. Amidst vital stages like market analysis and requirement assessments, the heart of software development lies in the meticulous creation and upkeep of source code. Code alterations are inherent, challenging code quality, particularly under stringent deadlines.
Preparing Non - Technical Founders for Engaging a Tech AgencyISH Technologies
Preparing non-technical founders before engaging a tech agency is crucial for the success of their projects. It starts with clearly defining their vision and goals, conducting thorough market research, and gaining a basic understanding of relevant technologies. Setting realistic expectations and preparing a detailed project brief are essential steps. Founders should select a tech agency with a proven track record and establish clear communication channels. Additionally, addressing legal and contractual considerations and planning for post-launch support are vital to ensure a smooth and successful collaboration. This preparation empowers non-technical founders to effectively communicate their needs and work seamlessly with their chosen tech agency.Visit our site to get more details about this. Contact us today www.ishtechnologies.com.au
Transform Your Communication with Cloud-Based IVR SolutionsTheSMSPoint
Discover the power of Cloud-Based IVR Solutions to streamline communication processes. Embrace scalability and cost-efficiency while enhancing customer experiences with features like automated call routing and voice recognition. Accessible from anywhere, these solutions integrate seamlessly with existing systems, providing real-time analytics for continuous improvement. Revolutionize your communication strategy today with Cloud-Based IVR Solutions. Learn more at: https://thesmspoint.com/channel/cloud-telephony
May Marketo Masterclass, London MUG May 22 2024.pdfAdele Miller
Can't make Adobe Summit in Vegas? No sweat because the EMEA Marketo Engage Champions are coming to London to share their Summit sessions, insights and more!
This is a MUG with a twist you don't want to miss.
Essentials of Automations: The Art of Triggers and Actions in FMESafe Software
In this second installment of our Essentials of Automations webinar series, we’ll explore the landscape of triggers and actions, guiding you through the nuances of authoring and adapting workspaces for seamless automations. Gain an understanding of the full spectrum of triggers and actions available in FME, empowering you to enhance your workspaces for efficient automation.
We’ll kick things off by showcasing the most commonly used event-based triggers, introducing you to various automation workflows like manual triggers, schedules, directory watchers, and more. Plus, see how these elements play out in real scenarios.
Whether you’re tweaking your current setup or building from the ground up, this session will arm you with the tools and insights needed to transform your FME usage into a powerhouse of productivity. Join us to discover effective strategies that simplify complex processes, enhancing your productivity and transforming your data management practices with FME. Let’s turn complexity into clarity and make your workspaces work wonders!
Atelier - Innover avec l’IA Générative et les graphes de connaissancesNeo4j
Atelier - Innover avec l’IA Générative et les graphes de connaissances
Allez au-delà du battage médiatique autour de l’IA et découvrez des techniques pratiques pour utiliser l’IA de manière responsable à travers les données de votre organisation. Explorez comment utiliser les graphes de connaissances pour augmenter la précision, la transparence et la capacité d’explication dans les systèmes d’IA générative. Vous partirez avec une expérience pratique combinant les relations entre les données et les LLM pour apporter du contexte spécifique à votre domaine et améliorer votre raisonnement.
Amenez votre ordinateur portable et nous vous guiderons sur la mise en place de votre propre pile d’IA générative, en vous fournissant des exemples pratiques et codés pour démarrer en quelques minutes.
OpenMetadata Community Meeting - 5th June 2024OpenMetadata
The OpenMetadata Community Meeting was held on June 5th, 2024. In this meeting, we discussed about the data quality capabilities that are integrated with the Incident Manager, providing a complete solution to handle your data observability needs. Watch the end-to-end demo of the data quality features.
* How to run your own data quality framework
* What is the performance impact of running data quality frameworks
* How to run the test cases in your own ETL pipelines
* How the Incident Manager is integrated
* Get notified with alerts when test cases fail
Watch the meeting recording here - https://www.youtube.com/watch?v=UbNOje0kf6E
Artificia Intellicence and XPath Extension FunctionsOctavian Nadolu
The purpose of this presentation is to provide an overview of how you can use AI from XSLT, XQuery, Schematron, or XML Refactoring operations, the potential benefits of using AI, and some of the challenges we face.
3. Why do we need good documentation?
What qualities distinguish “good”
documentation?
How can we communicate with
developers?
How can we improve existing
documentation?
17. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
18. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
19. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
20. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
21. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
22. What is good documentation?
A comprehensive,
navigable
resource that
provides users the
information to build
a painless,
maintainable,
successful
integration to your
service.
24. Technical Reference
• Describe everything in your
API
– Even things you don’t want
people to use
• Structure should follow the
structure of the API
– But can intentionally diverge
• Primarily values:
comprehensive, navigable
• Shortcuts: API design,
‘automatic’ documentation,
formatting
27. Automatic
Documentation
• Less error-prone
• Takes less time
… but it’s only part of the
story!
• Documentation needs to
explain things to people
– Different writing skills
• Communication is too
important to play second
fiddle in comments
28.
29. Code Snippets
• Allow users to learn by
example
• Demonstrate a single call
• Need to be able to
copy/paste content
– Must work!
• Primary values: painless
• Code should be simple,
readable (not clever)
• Example: Stripe, Twilio
35. Which Languages?
• At least three languages
• At least one raw call/response
sample
• Two additional samples implies
multi-language support
• Popularity
• Target audience
• The more the merrier
• as long as
they’re
maintainable
37. IEEE Spectrum:
Top Programming Languages (web)
http://spectrum.ieee.org/static/interactive-the-top-programming-languages#index
38. Fancy Code Snippets
via interactive console
• Allows users to
play with data
• Real calls to API
• User credentials,
parameters
• Tools:
- Mashery I/O Docs
- Apigee
- 3scale
54. Application Samples
• More fully-fledged
“learning by example”
• Full integration within an
application context
• Larger samples
• More like a POC
• Primary values:
readability, navigability
• Example: Twilio
56. Q&A resources
• There will still be
unanswered questions
– Specific use cases
– Combinations of
resources
• Public answers
benefit the
community
• Primary values:
navigability,
simplicity
61. A comprehensive, navigable resource
that provides users the information
to build a painless, maintainable,
successful integration to your
service.
• Technical Reference
• Sample Code/code snippets
• Tutorials (written, video,
interactive)
• Application Samples
• Q&A resources
64. What documentation do they
offer?
Technical
Reference
Code
Snippets Tutorials
Interactive
Console SDK
Application
Samples Q&A
Facebook yes yes yes yes yes yes yes
Google Maps yes yes yes no yes no stack overflow
Twitter yes JSON only yes yes some no yes
YouTube yes yes yes yes yes no stack overflow
AccuWeather yes no* yes no no no no
LinkedIn yes yes yes yes 3rd party no yes
Amazon Product
Advertising yes 3rd party yes no 3rd party 3rd party yes
Pinterest yes no yes no yes no no
Flickr yes 3rd party yes yes 3rd party no yes
Google Talk** yes yes yes no yes no yes
Twilio yes yes yes no yes yes yes
Skype URI yes yes yes no no no yes
Waze yes yes yes no no no yes
Yahoo Weather yes yes yes yes no no yes
* Does provide a JavaScript sample for one resource
** Replaced May 2013, no longer updated
65. Comprehensive vs. Concise?
• Comprehensive
– Full coverage for technical references
– Common use cases for tutorials/samples
• Length becomes an issue
– affects navigation
- dilutes understanding
- impacts maintenance
67. Keep it up to date!
• Inaccurate is as
bad as missing
• Only way to make
integrations
maintainable
68. Creating Documentation
• Don’t build it from
scratch
• Evaluate the best
description format
for you
• Use existing tools
to make your site
all fancy
• Continue to evolve
I'll talk about why good documentation is so important. I'll cover some different
ways to engage with developers through documentation
and what qualities you should look for in each of those methods. We'll take a look at some examples of
good documentation for each of those.
Then we'll take a look at some hypothetical, terrible documentation and refactor it into good documentation. That
should be the fun part.
Let's start easy.
I hope you're all in agreement with me on this one: your API needs documentation.
No API is entirely self-explanatory.
You may have the most elegant, intuitive API possible, but you still need documentation. And I don't
mean just a list of fields with descriptions. That's essential, but it needs to go deeper than that.
There are complexities to your business. To your product. Those need to be clear to your users.
There are a lot of other talks here about helping machines communicate with other machines. That's not
what I mean here. This is communicating with humans.
In practice…
More specifically
If your documentation is good, it can do some great things.
Here are the easy ones:
- It decreases barriers to entry. It's easier to use your product since it's well documented, so it takes
less time and effort to get it up and running.
- It decreases support burden and costs. Developers aren't calling or emailing with as many questions,
and as they continue to modify or update their code, they have a reference to go back to. Even if you
walk them through it step by step now, after six or eight months, they'll forget all that information.
Write it down! Make it accessible. It's less expensive for you and for them.
So, In addition to being purely informative, what else can documentation imply to your developer customers?
It can reduce costs of implementation and support and all that, but
it also works as a marketing tool.
Often, you're selling a product to a business guy.
This is a business cat – he is wearing a tie.
He's going to make
the decision that this product looks like it meets the business needs. He's not going to be writing the
code, but he's maybe a tech-literate guy, and as part of the evaluation process, he wants to make sure
that his dev will have what he needs to get the job done. If you can send him to documentation that is
clearly easy to navigate and even just appears to be helpful, that goes a long way towards reassuring him.
This is a developer cat – he is wearing a hoodie.
When his dev looks at it, he also impressed and reassured, and the integration process looks easier.
This marketing perspective isn’t a full evaluation of everything your API can do. Not yet.
This is just 'can I make a request and get a response'? How does it feel when I kick the tires?
If that incredibly basic request/response is easy, it makes me feel like a successful
reader. It will certainly get trickier, but I have one easy win under my belt. I can do this - no problem.
If the 'zero to hello world' seems too complicated, well, that was the easiest thing of all the things I will need to do.
It's only going to get harder as I try to reflect more complicated use cases and look at more complicated
representations. I'm defeated before I begin.
If your documentation is bad, there are a couple of things users might think.
They might think that if your documentation is shoddy, your product is also shoddy. That the quality of
the documentation accurately reflects
the state of your service. In that case, they will doubt that your product can actually
deliver on what you promised in your much swankier marketing materials.
Okay, let's call that the worse case. That your bad documentation undermines any perception of
a quality product. That sounds pretty bad.
In the very best case, they give you the benefit of the doubt that your product does, in fact, work as
advertised (and as well as advertised). In that case, you must not care about engaging developers as
an audience. Their success and ease of product use is not important to you as a business. And that's not
nice either. That's our best case. That your readers assume that everything else is great, just not
this one incredibly essential part of their engagement with you and your company. And that they are not
important to you. So much so that you have not bothered to write down the answers to questions you know
they will have. 'What are the resources I can call and how do I call them?'
What will happen when they come up with other, more meaningful, questions? Harder questions?
What kind of support should they expect in those cases?
If you have bad documentation, it’s not the end of the world. When I started in my group, we emailed developers a 35-page PDF document. There was no central location where the PDF was available, so people were always asking each other “is this the latest one? Do you have the latest one?” which was kind of a joke, because the document had no relation to our service versioning.
It had an index. So, that was our documentation. We’ve come a long way since then, but that’s where we started.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to udpate to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to udpate to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to update to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to update to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to update to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
So. Good documentation is good. Super. What makes documentation good?
A feature-complete, self-service resource that provides users with all the information necessary to
build a painless, maintainable, successful integration to your service.
What do I mean here?
Feature-complete. everything is documented. even things you don't really want people to use. If it's out
there, and they could possibly find it, it needs to be documented. If you don't want them to use something,
by all means, document that.
Self-service. users can find what they need without assistance.
Painless. that's bringing back our 'zero to hello world' concept, but bigger. This is all the things that
are undeniably necessary (technical references), as well as the things that make integration much much
easier. Things like sample code, tutorials that cover use cases, etc. This is the big content driver,
we'll talk about this more later.
Maintainable. in two years when some other dev opens up the integration code, will they be able to see
what your API did then? Will they be able to make enhancements? Will they be able to update to the latest
API version? Are you, as a documenter, confident that you are updating everything that needs to be updated
when a new release is pushed to production?
Successful. if there are industry concerns that you have - if there are particular use cases that
require special attention, you need to make sure to cover all of them. If you are payment processor, and you
need to impress upon your users the need to not store credit card information, that's something that needs to be included.
If this is the goal we're trying to achieve, what are the elements we can use to reach this goal?
I'm going to talk about five different types of documentation. You should offer all of them.
Technical reference
This is what most people think of when they think of API documentation. What are the bare facts of calling your API?
what are the resources, methods, parameters, so on.
Sample code/code snippets
These are copy-pasteable bits of code that demonstrate a particular use. Just one call - not a whole use case.
Tutorials (written, video, interactive)
Explanation of particular use cases or workflows
Application samples
Sample code with context. This is often a (bare-bones) stand-alone application that includes integration to your API.
Q&A resources
Somewhere people can go when they're unsure.
A description of something should follow the structure of the thing itself. In that way, even the
structure of your documentation can imply the structure of your API. After all, your documentation
is the human-discoverable representation of your API.
If your API is well-designed and well-structured, if it really is intuitive, you can avoid some
amount of volume in your documentation. Not because those things don't need documenting - they do!
They're just documented elsewhere. The biggest pain points in usability are when things
don't do what your user expects - you need to document those things incredibly carefully.
Stellar is a decentralized protocol for sending and receiving money in any pair of currencies
Documentation is iterative. And even a little can go a long way.
Remember that PDF documentation?
3 ½ years ago…
86 cases (last August) to 12 cases (last month)
With all these tools and resources available to you, I hope you’re inspired to brush up your documentation!