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.
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.
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.
Cherryleaf’s Ellis Pratt will be speaking at Lavacon’s first European conference. This will be held on 5-8 June, at the Trinity College Conference Centre, Dublin. Ellis’ presentation will be on the 7th June 2016
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.
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 key aspects of engineering culture at companies. It notes that while college teaches technical skills, it does not teach important aspects of working at a company like code reviews, testing, documentation, and onboarding processes. A good culture values planning, writing consistent code, testing, code reviews, efficient release processes, monitoring code, and learning from mistakes through post-mortems. The document emphasizes that culture has a large impact on the work experience and success of engineering teams.
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.
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.
Cherryleaf’s Ellis Pratt will be speaking at Lavacon’s first European conference. This will be held on 5-8 June, at the Trinity College Conference Centre, Dublin. Ellis’ presentation will be on the 7th June 2016
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.
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 key aspects of engineering culture at companies. It notes that while college teaches technical skills, it does not teach important aspects of working at a company like code reviews, testing, documentation, and onboarding processes. A good culture values planning, writing consistent code, testing, code reviews, efficient release processes, monitoring code, and learning from mistakes through post-mortems. The document emphasizes that culture has a large impact on the work experience and success of engineering teams.
The document discusses what constitutes good API documentation. It states that good documentation includes technical references, code samples, tutorials, application samples, and Q&A resources. It should provide enough information for developers to easily integrate with an API in a painless and maintainable way. While comprehensive documentation is ideal, it needs to remain concise and navigable. Documentation also needs to be kept up to date as APIs evolve. A variety of formats for documentation are discussed, as well as tools that can help generate documentation automatically.
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.
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.
5 Keys to API Design - API Days Paris 2013Daniel Feist
This document discusses 5 keys to API design: 1) The API contract is critical as it tells developers what to expect and deliver, enables parallel development, and ensures requirements are met. 2) Design to delight users by gathering feedback and iterating quickly. 3) Think of APIs as APX (API Experience) and craft them for user enjoyment. 4) Leverage patterns for resource types, collections, traits and more. 5) Engage developers through social tools, interactive consoles and prototyping tools to get their feedback. The document also promotes the RAML specification for modeling RESTful APIs in a clean, structured way.
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.
DevRel Salon - Writing Decent Documentation, a learning journey with plenty o...Abdelhalim DADOUCHE
The January 2020 DevRel Salon topic was around "documentation" where I was asked to share my experience.
This talk try to transcribe some of the key learnings over 20 years as a support engineer, and developer (somehow), a consultant, an architect and last but not least as a Developer Advocate at SAP.
Exploring Content API Options - March 23rd 2016Jani Tarvainen
Today the market is awash with options available for developers to consume content using the APIs. Some go as far as describing their offering as a CMS without the bad parts, where as some choose to provide content using a data centric API platform.
All of this while the classic Content Management System players are opening up their core via APIs and modernising their technical platforms. Is there a silver bullet for Content APIs? Let's find out!
Original presentation format available on Sway: https://sway.com/YIZfYDgcQyJwcmWI
Testing with an Accent: Internationalization TestingTechWell
Finding time to test the basic functionality, performance, and security of a system is difficult enough, so how do you find time to add internationalization (i18n) and localization (l10n) testing? Today’s world is very small, and you may already have international users in your target market. Can you really afford to ignore those who can’t enter their name correctly with the default US-ASCII character set? Will it still be a quality product to them? Paul Carvalho shares how you can—with a little creative thinking and design—incorporate i18n and l10n testing into your regular routine. Great testing requires the right mindset, applied insight, preparation, and dedication. Learn how to identify the system elements that pose juicy risks; go beyond looking at the UI, using simple tools and tricks you can try right away; and discuss ways to integrate i18n into your functional testing in a fun way with little overhead. Impress your co-workers and delight your customers!
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.
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
The next generation of google APIs (Ade Oshineye)Ontico
The document discusses the next generation of Google APIs and lessons learned from previous API efforts. It advocates for a unified and developer-focused API experience that is easy to use, solves real problems, and provides tools like API exploration, client libraries, and issue tracking. Key points include defaulting to JSON, embracing standards while prioritizing usability, supporting multiple access methods like REST and RPC, and iterating based on developer feedback to continuously improve the experience.
This is my presentation for Global Azure Verona 2021, where I talked about Azure Functions and how this technology can be used to process messages that come from WhatsApp in a chatbot environment.
Lessons learned on the Azure API Stewardship Journey.pptxapidays
apidays LIVE Singapore 2022: Digitising at scale with APIs
April 20 & 21, 2022
Lessons learned on the Azure API Stewardship Journey
Adrian Hall, Principal Product Manager at Microsoft
------------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
Implementing a Multi-Device Approach to E-learning Design (US Session)Raptivity
This document discusses implementing a multi-device approach to e-learning design. It addresses the current reality of accessing content on multiple devices and browsers. It also discusses challenges like supporting different content types, managing future changes and transitions, and testing across devices. The document promotes using HTML5, CSS3 and JavaScript for content due to benefits like responsive design and accessibility. It also demonstrates rapid interactivity building tools like Raptivity that can be used to create instructionally sound interactions without coding.
The document provides information about a user experience bootcamp presented by Catherine Robson. The bootcamp covers topics like understanding user needs through user stories and personas, designing user flows and wireframes, testing prototypes, and best practices for visual design. The goal is to help developers spend less time fixing issues by taking a user-centric approach to design.
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.
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.
Here is something cool we did. We’ve mapped out the entire HR life cycle and identified areas where chatbots can help increase productivity and decrease costs.
Check out our document to find more.
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.
Introducing Crescat - Event Management Software for Venues, Festivals and Eve...Crescat
Crescat is industry-trusted event management software, built by event professionals for event professionals. Founded in 2017, we have three key products tailored for the live event industry.
Crescat Event for concert promoters and event agencies. Crescat Venue for music venues, conference centers, wedding venues, concert halls and more. And Crescat Festival for festivals, conferences and complex events.
With a wide range of popular features such as event scheduling, shift management, volunteer and crew coordination, artist booking and much more, Crescat is designed for customisation and ease-of-use.
Over 125,000 events have been planned in Crescat and with hundreds of customers of all shapes and sizes, from boutique event agencies through to international concert promoters, Crescat is rigged for success. What's more, we highly value feedback from our users and we are constantly improving our software with updates, new features and improvements.
If you plan events, run a venue or produce festivals and you're looking for ways to make your life easier, then we have a solution for you. Try our software for free or schedule a no-obligation demo with one of our product specialists today at crescat.io
A Study of Variable-Role-based Feature Enrichment in Neural Models of CodeAftab Hussain
Understanding variable roles in code has been found to be helpful by students
in learning programming -- could variable roles help deep neural models in
performing coding tasks? We do an exploratory study.
- These are slides of the talk given at InteNSE'23: The 1st International Workshop on Interpretability and Robustness in Neural Software Engineering, co-located with the 45th International Conference on Software Engineering, ICSE 2023, Melbourne Australia
More Related Content
Similar to Engaging a Developer Audience: Documentation and More
The document discusses what constitutes good API documentation. It states that good documentation includes technical references, code samples, tutorials, application samples, and Q&A resources. It should provide enough information for developers to easily integrate with an API in a painless and maintainable way. While comprehensive documentation is ideal, it needs to remain concise and navigable. Documentation also needs to be kept up to date as APIs evolve. A variety of formats for documentation are discussed, as well as tools that can help generate documentation automatically.
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.
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.
5 Keys to API Design - API Days Paris 2013Daniel Feist
This document discusses 5 keys to API design: 1) The API contract is critical as it tells developers what to expect and deliver, enables parallel development, and ensures requirements are met. 2) Design to delight users by gathering feedback and iterating quickly. 3) Think of APIs as APX (API Experience) and craft them for user enjoyment. 4) Leverage patterns for resource types, collections, traits and more. 5) Engage developers through social tools, interactive consoles and prototyping tools to get their feedback. The document also promotes the RAML specification for modeling RESTful APIs in a clean, structured way.
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.
DevRel Salon - Writing Decent Documentation, a learning journey with plenty o...Abdelhalim DADOUCHE
The January 2020 DevRel Salon topic was around "documentation" where I was asked to share my experience.
This talk try to transcribe some of the key learnings over 20 years as a support engineer, and developer (somehow), a consultant, an architect and last but not least as a Developer Advocate at SAP.
Exploring Content API Options - March 23rd 2016Jani Tarvainen
Today the market is awash with options available for developers to consume content using the APIs. Some go as far as describing their offering as a CMS without the bad parts, where as some choose to provide content using a data centric API platform.
All of this while the classic Content Management System players are opening up their core via APIs and modernising their technical platforms. Is there a silver bullet for Content APIs? Let's find out!
Original presentation format available on Sway: https://sway.com/YIZfYDgcQyJwcmWI
Testing with an Accent: Internationalization TestingTechWell
Finding time to test the basic functionality, performance, and security of a system is difficult enough, so how do you find time to add internationalization (i18n) and localization (l10n) testing? Today’s world is very small, and you may already have international users in your target market. Can you really afford to ignore those who can’t enter their name correctly with the default US-ASCII character set? Will it still be a quality product to them? Paul Carvalho shares how you can—with a little creative thinking and design—incorporate i18n and l10n testing into your regular routine. Great testing requires the right mindset, applied insight, preparation, and dedication. Learn how to identify the system elements that pose juicy risks; go beyond looking at the UI, using simple tools and tricks you can try right away; and discuss ways to integrate i18n into your functional testing in a fun way with little overhead. Impress your co-workers and delight your customers!
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.
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
The next generation of google APIs (Ade Oshineye)Ontico
The document discusses the next generation of Google APIs and lessons learned from previous API efforts. It advocates for a unified and developer-focused API experience that is easy to use, solves real problems, and provides tools like API exploration, client libraries, and issue tracking. Key points include defaulting to JSON, embracing standards while prioritizing usability, supporting multiple access methods like REST and RPC, and iterating based on developer feedback to continuously improve the experience.
This is my presentation for Global Azure Verona 2021, where I talked about Azure Functions and how this technology can be used to process messages that come from WhatsApp in a chatbot environment.
Lessons learned on the Azure API Stewardship Journey.pptxapidays
apidays LIVE Singapore 2022: Digitising at scale with APIs
April 20 & 21, 2022
Lessons learned on the Azure API Stewardship Journey
Adrian Hall, Principal Product Manager at Microsoft
------------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
Implementing a Multi-Device Approach to E-learning Design (US Session)Raptivity
This document discusses implementing a multi-device approach to e-learning design. It addresses the current reality of accessing content on multiple devices and browsers. It also discusses challenges like supporting different content types, managing future changes and transitions, and testing across devices. The document promotes using HTML5, CSS3 and JavaScript for content due to benefits like responsive design and accessibility. It also demonstrates rapid interactivity building tools like Raptivity that can be used to create instructionally sound interactions without coding.
The document provides information about a user experience bootcamp presented by Catherine Robson. The bootcamp covers topics like understanding user needs through user stories and personas, designing user flows and wireframes, testing prototypes, and best practices for visual design. The goal is to help developers spend less time fixing issues by taking a user-centric approach to design.
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.
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.
Here is something cool we did. We’ve mapped out the entire HR life cycle and identified areas where chatbots can help increase productivity and decrease costs.
Check out our document to find more.
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.
Similar to Engaging a Developer Audience: Documentation and More (20)
Introducing Crescat - Event Management Software for Venues, Festivals and Eve...Crescat
Crescat is industry-trusted event management software, built by event professionals for event professionals. Founded in 2017, we have three key products tailored for the live event industry.
Crescat Event for concert promoters and event agencies. Crescat Venue for music venues, conference centers, wedding venues, concert halls and more. And Crescat Festival for festivals, conferences and complex events.
With a wide range of popular features such as event scheduling, shift management, volunteer and crew coordination, artist booking and much more, Crescat is designed for customisation and ease-of-use.
Over 125,000 events have been planned in Crescat and with hundreds of customers of all shapes and sizes, from boutique event agencies through to international concert promoters, Crescat is rigged for success. What's more, we highly value feedback from our users and we are constantly improving our software with updates, new features and improvements.
If you plan events, run a venue or produce festivals and you're looking for ways to make your life easier, then we have a solution for you. Try our software for free or schedule a no-obligation demo with one of our product specialists today at crescat.io
A Study of Variable-Role-based Feature Enrichment in Neural Models of CodeAftab Hussain
Understanding variable roles in code has been found to be helpful by students
in learning programming -- could variable roles help deep neural models in
performing coding tasks? We do an exploratory study.
- These are slides of the talk given at InteNSE'23: The 1st International Workshop on Interpretability and Robustness in Neural Software Engineering, co-located with the 45th International Conference on Software Engineering, ICSE 2023, Melbourne Australia
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
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
Microservice Teams - How the cloud changes the way we workSven Peters
A lot of technical challenges and complexity come with building a cloud-native and distributed architecture. The way we develop backend software has fundamentally changed in the last ten years. Managing a microservices architecture demands a lot of us to ensure observability and operational resiliency. But did you also change the way you run your development teams?
Sven will talk about Atlassian’s journey from a monolith to a multi-tenanted architecture and how it affected the way the engineering teams work. You will learn how we shifted to service ownership, moved to more autonomous teams (and its challenges), and established platform and enablement teams.
SMS API Integration in Saudi Arabia| Best SMS API ServiceYara Milbes
Discover the benefits and implementation of SMS API integration in the UAE and Middle East. This comprehensive guide covers the importance of SMS messaging APIs, the advantages of bulk SMS APIs, and real-world case studies. Learn how CEQUENS, a leader in communication solutions, can help your business enhance customer engagement and streamline operations with innovative CPaaS, reliable SMS APIs, and omnichannel solutions, including WhatsApp Business. Perfect for businesses seeking to optimize their communication strategies in the digital age.
Do you want Software for your Business? Visit Deuglo
Deuglo has top Software Developers in India. They are experts in software development and help design and create custom Software solutions.
Deuglo follows seven steps methods for delivering their services to their customers. They called it the Software development life cycle process (SDLC).
Requirement — Collecting the Requirements is the first Phase in the SSLC process.
Feasibility Study — after completing the requirement process they move to the design phase.
Design — in this phase, they start designing the software.
Coding — when designing is completed, the developers start coding for the software.
Testing — in this phase when the coding of the software is done the testing team will start testing.
Installation — after completion of testing, the application opens to the live server and launches!
Maintenance — after completing the software development, customers start using the software.
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.
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!
Most important New features of Oracle 23c for DBAs and Developers. You can get more idea from my youtube channel video from https://youtu.be/XvL5WtaC20A
8 Best Automated Android App Testing Tool and Framework in 2024.pdfkalichargn70th171
Regarding mobile operating systems, two major players dominate our thoughts: Android and iPhone. With Android leading the market, software development companies are focused on delivering apps compatible with this OS. Ensuring an app's functionality across various Android devices, OS versions, and hardware specifications is critical, making Android app testing essential.
What is Master Data Management by PiLog Groupaymanquadri279
PiLog Group's Master Data Record Manager (MDRM) is a sophisticated enterprise solution designed to ensure data accuracy, consistency, and governance across various business functions. MDRM integrates advanced data management technologies to cleanse, classify, and standardize master data, thereby enhancing data quality and operational efficiency.
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. 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
33. 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
35. IEEE Spectrum:
Top Programming Languages (web)
http://spectrum.ieee.org/static/interactive-the-top-programming-languages#index
36. 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
49. 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: Facebook
51. Q&A resources
• There will still be
unanswered questions
– Specific use cases
– Combinations of
resources
• Public answers
benefit the
community
• Primary values:
navigability,
simplicity
56. 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
59. 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
60. 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
62. 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.
There's a term that I like that's sometimes used to describe this early stage of evaluation and adoption -
"zero to 'hello world'". I think that's very descriptive of what a first glance at docs can achieve.
I'm not talking about a full implementation or even 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.
Documentation is iterative. And even a little can go a long way.