The document discusses the evolution of software documentation from simple readme files to a major component of modern software. It notes testers now must thoroughly test documentation in addition to code. Documentation comes in many forms, from user manuals to help systems integrated into software. The document provides a checklist for documentation testing covering audience, content, examples, formatting and accuracy. It also discusses auto-generating documentation from source code comments.
Introduction to Free and Open Source Software (FOSS) License by nexB.
You can see a list of most popular FOSS license in DejaCode, visit us at https://enterprise.dejacode.com/landing/
nexB - Software audit for product releasenexB Inc.
As the use of open source software components grows across all industry supply chains, more customers are asking their suppliers to:
- Provide detailed information about the open source content of supplier products, and
- Proactively fulfill all attribution or software redistribution obligations associated with the open source components.
nexB offers a wide range of professional services to help software organizations identify and comply with software license obligations for open source and other third-party components. See http://www.nexb.com/services.html
Introduction to Free and Open Source Software (FOSS) License by nexB.
You can see a list of most popular FOSS license in DejaCode, visit us at https://enterprise.dejacode.com/landing/
nexB - Software audit for product releasenexB Inc.
As the use of open source software components grows across all industry supply chains, more customers are asking their suppliers to:
- Provide detailed information about the open source content of supplier products, and
- Proactively fulfill all attribution or software redistribution obligations associated with the open source components.
nexB offers a wide range of professional services to help software organizations identify and comply with software license obligations for open source and other third-party components. See http://www.nexb.com/services.html
Dreamz Samhita Apartments located at JP Nagar. Currently the project is under construction. Dreamz Samhita is a G+5 building and offering both 2BHK & 3BHK apartments with many amenities. If you're looking to buy apartments flats in JP Nagar Bangalore region approach Dreamz Infra. The apartments prices are very low. You will get your dream home at very affordable price., For more details visit: http://www.dreamzinfra.com/flats-in-jp-nagar/
Capability Building for Cyber Defense: Software Walk through and Screening Maven Logix
Dr. Fahim Arif who is the Director R&D at MCS, principal investigator and GHQ authorized consultant for Nexsource Pak (Pvt) Ltd) discussed the capability of building cyber defense in the Data Protection and Cyber Security event that was hosted recently by Maven Logix. In his session he gave the audience valuable information about the life cycle of a cyber-threat discussing what and how to take measures by performing formal code reviews, code inspections. He discussed essential elements of code review, paired programming and alternatives to treat and tackle cyber-threat
Dr Mark Hooper's presentation from our April Translation and Transcreation Workshop. How does the translation process work? How can you get the best for your translation project from your Language Service Provider? What does technology mean for translation? What are the differences between translation, transcreation and localisation? This informative presentation answers all of these questions and more.
Illustrated Code: Building Software in a Literate Way
Andreas Zeller, CISPA Helmholtz Center for Information Security
Notebooks – rich, interactive documents that join together code, documentation, and outputs – are all the rage with data scientists. But can they be used for actual software development? In this talk, I share experiences from authoring two interactive textbooks – fuzzingbook.org and debuggingbook.org – and show how notebooks not only serve for exploring and explaining code and data, but also how they can be used as software modules, integrating self-checking documentation, tests, and tutorials all in one place. The resulting software focuses on the essential, is well-documented, highly maintainable, easily extensible, and has a much higher shelf life than the "duct tape and wire” prototypes frequently found in research and beyond.
A software system is more than the code; it is a set of related artifacts; these may contain defects or problem areas that should be reworked or removed; quality-related attributes of these artifacts should be evaluated
Reviews allow us to detect and eliminate errors/defects early in the software life cycle (even before any code is available for testing), where they are less costly to repair
Most problems have their origin in requirements and design; requirements and design artifacts can be reviewed but not executed and tested
A code review usually reveals directly the location of a bug, while testing requires a debugging step to locate the origin of a bug
Adherence to coding standards cannot be checked by testing
Dreamz Samhita Apartments located at JP Nagar. Currently the project is under construction. Dreamz Samhita is a G+5 building and offering both 2BHK & 3BHK apartments with many amenities. If you're looking to buy apartments flats in JP Nagar Bangalore region approach Dreamz Infra. The apartments prices are very low. You will get your dream home at very affordable price., For more details visit: http://www.dreamzinfra.com/flats-in-jp-nagar/
Capability Building for Cyber Defense: Software Walk through and Screening Maven Logix
Dr. Fahim Arif who is the Director R&D at MCS, principal investigator and GHQ authorized consultant for Nexsource Pak (Pvt) Ltd) discussed the capability of building cyber defense in the Data Protection and Cyber Security event that was hosted recently by Maven Logix. In his session he gave the audience valuable information about the life cycle of a cyber-threat discussing what and how to take measures by performing formal code reviews, code inspections. He discussed essential elements of code review, paired programming and alternatives to treat and tackle cyber-threat
Dr Mark Hooper's presentation from our April Translation and Transcreation Workshop. How does the translation process work? How can you get the best for your translation project from your Language Service Provider? What does technology mean for translation? What are the differences between translation, transcreation and localisation? This informative presentation answers all of these questions and more.
Illustrated Code: Building Software in a Literate Way
Andreas Zeller, CISPA Helmholtz Center for Information Security
Notebooks – rich, interactive documents that join together code, documentation, and outputs – are all the rage with data scientists. But can they be used for actual software development? In this talk, I share experiences from authoring two interactive textbooks – fuzzingbook.org and debuggingbook.org – and show how notebooks not only serve for exploring and explaining code and data, but also how they can be used as software modules, integrating self-checking documentation, tests, and tutorials all in one place. The resulting software focuses on the essential, is well-documented, highly maintainable, easily extensible, and has a much higher shelf life than the "duct tape and wire” prototypes frequently found in research and beyond.
A software system is more than the code; it is a set of related artifacts; these may contain defects or problem areas that should be reworked or removed; quality-related attributes of these artifacts should be evaluated
Reviews allow us to detect and eliminate errors/defects early in the software life cycle (even before any code is available for testing), where they are less costly to repair
Most problems have their origin in requirements and design; requirements and design artifacts can be reviewed but not executed and tested
A code review usually reveals directly the location of a bug, while testing requires a debugging step to locate the origin of a bug
Adherence to coding standards cannot be checked by testing
Querix 4 gl app analyzer 2016 journey to the center of your 4gl applicationBeGooden-IT Consulting
if you run and maintain an Informix 4GL application, the documentation of this project may be a hot topic for different reasons. Check this presentation and find the solution you really need
1. Topics in Testing Software
Documentation
[Reading assignment: Chapter 12, pp. 183-191]
2. The good old days
• Software documentation was:
– a readme.txt file copied onto the software’s
floppy disk
– a 1 page insert put into the shrink-wrapped
package containing the software
– comments in the source code!
– Unix man pages are still in vogue, however …
• Testers ran a spell checker on the file and
that was about the extent of testing the
documentation.
3. Today …
• Much of the non-code is the software
documentation, which requires much effort to
produce.
• Documentation is now a major part of a
software system.
– It might exceed the amount of source code!
– It might be integrated into the software (e.g., help
system)
• Testers have to cover the code and the
documentation.
– Assuring that the documentation is correct is part
of a software tester’s job.
4. Classes of
software documentation
• Packaging text and graphics
• Marketing material, ads, and other inserts
• Warranty/registration
• End User License Agreement (EULA)
• Labels and stickers
• Installation and setup instructions
• User’s manual
• Online help
• Tutorials, wizards, and computer-based training
• Samples, examples, and templates
• Error messages
5. Importance of
documentation testing
• Improves usability
– Not all software was written for the Mac :-)
• Improves reliability
– Testing the documentation is part of black-box
testing.
– A bug in the user manual is like a bug in the
software.
• Lowers support cost
– The exercise of writing the documentation helped
debug the system.
6. Testing software documents
• Loosely coupled to the code:
– E.g., user manuals, packaging fliers.
– Apply techniques on specification testing and
software inspection.
– Think of it as technical editing or proofreading.
• Tightly coupled to the code:
– E.g., documents are an integral part of the
software, such as a training system or TurboTax
Deluxe (fancy videos, hyperlinked manual, etc).
– Apply techniques such as black-box and white-box
testing.
7. Documentation
testing checklist
• Audience:
– E.g., make sure documentation is not too novice or too
advanced.
• Terminology:
– Is it suitable for the audience?
– Terms used consistently?
– Abbreviations for acronyms?
• Content and subject matter:
– Appropriate subjects covered?
– No subjects missing?
– Proper depth?
– Missing features described accidentally?
8. Documentation
testing checklist (cont’d)
• Just the facts:
– All information technically correct?
– Correct table of contents, index, chapter references?
– Correct website URLs, phone numbers?
• Step by step:
– Any missing steps?
– Compared tester results to those shown in the documentation?
• Figures and screen captures:
– Accurate and precise?
– Are they from the latest version of the software?
– Are the figure captions correct?
• Samples and examples:
– Do all the examples work as advertised?
• Spelling and grammar
9. Auto-generated code
documents
• Tools such as:
– Doxygen
– Javadoc
– ROBODoc
– POD
– TwinText
can be used to auto-generate the code documents
from source code comments and create HTML
reference manuals.
• Code documents can be organized into a reference
guide style that enables programmers to quickly look
up functions or classes.
• Comprehensive survey of code documentation tools:
– http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
/**
* The time class represents a moment of time.
*
* author John Doe
*/
class Time {
/**
* Constructor that sets the time to a given
* value.
* param timemillis is a number of milliseconds
* passed since Jan 1. 1970
*/
Time(int timemillis) { ... }
10. Discussion …
• Who should write software
documentation?
• Why is documentation a second-class
citizen compared to code?
• Why is keeping code/executables and
documentation consistent difficult?
– Is the problem inherent or due to sloppy
software engineering?
11. You now know …
• … the definition of software
documentation
• … the importance of testing software
documentation
• … what to look for when testing
software documentation
• … methods for testing software
documentation