Documentation testing

From Wikipedia, the free encyclopedia

Jump to navigationJump to search
hideThis article has multiple issues. Please help improve it or discuss
these issues on the talk page. (Learn how and when to remove these template
messages)
This article is an orphan, as no other articles link to it. Please introduce
links to this page from related articles; try the Find link tool for
suggestions.  (February 2017)
The examples and perspective in this article or section might have an
extensive bias or disproportional coverage towards software
development.  (June 2017)
This article may need to be rewritten to comply with Wikipedia's quality
standards.  (December 2016)
Documentation testing is part of the non-functional testing of a product. It
may be a type of black-box testing that ensures that documentation about
how to use the system matches with what the system does, providing proof
that system changes and improvements have been documented.[1]

Contents

 1Description
 2Key areas
 3See also
 4References

Description[edit]
Documentation testing includes the plans, results, and testing of a system or
system component. It includes test case specifications, test plans, test
procedures, test reports, and test logs. It is about the testing of all the
documents stating, defining, explaining, and reporting or
validating requirements, procedures followed, and results. Documentation
testing starts with the beginning of the very first software process to be the
most cost-effective.[2] Documentation testing includes checking the spelling
and grammar to review any ambiguity or inconsistency between what
functionality it performs and what it is supposed to do.
Product documentation is a critical part of the final product.[2] Poor
documentation can affect the product or company's reputation. [3]
Documentation is about the testing of all the documents created prior, and
after the testing of software.[4] Any delay in the testing of the document will
increase the cost.[5] Some common artifactsabout software development and
testing can be specified as test cases, test plans, requirements, and
traceability matrices.

Key areas[edit]
Four key areas for testing a document include instructions, examples,
messages, and samples. Instructions will be needed to step by step execute
the test scenarios for looking errors or their omission. Further examples can
be provided to elaborate the GUI components, syntax, commands,
and interfaces to show executed outputs or pinpoints. Inconsistencies also
needed to be taken care of with errors as they can confuse the users, and
these ambiguities will cause much damage if the user of the system will be
a novice user. Examples will be needed in case of any problem that occurs
to the user, particularly novice users who may check the documentation for
any confusion.
Documentation problems can be handled in formal ways, just the same way
as the coding problems.[6] Defect reporting tools and tracking tools are the
common solutions for handling defects, just like as they are handled in
code.

See also[edit]
 Owner's manual

References[edit]
1. ^ "What Is Documentation Testing? – Offshore Software
Testing with QATestLab".
2. ^ Jump up to: a b "What is documentation testing in software
testing?".
3. ^ "Why Documentation is Important in Software Testing? -
Software Testing Classes". softwaretestingclass.com. 26
November 2013.
4. ^ https://www.cs.drexel.edu/~spiros/teaching/SE320/slides/
documentation-testing.pdf[bare URL PDF]
5. ^ Company, DIANE Publishing (April 1994). A Guide to
Understanding Security Testing and Test Documentation in
Trusted Systems. DIANE Publishing. ISBN 978-0-7881-0699-6
6. ^ Gupta, Yoginder Nath. "New Post-Documentation Testing an
Important Activity in Software Testing".
Categories: 
 Software testing
 Product testing
 Technical communication
Navigation menu
 Not logged in
 Talk
 Contributions
 Create account
 Log in
 Article
 Talk
 Read
 Edit
 View history
 Main page
  Contents
 Current events
 Random article
 About Wikipedia
 Contact us
 Donate
Contribute
 Help
 Learn to edit
 Community portal
 Recent changes
 Upload file
Tools
 What links here
 Related changes
 Special pages
 Permanent link
 Page information
 Cite this page
 Wikidata item
Print/export
 Download as PDF
 Printable version
Languages
Add links
 This page was last edited on 14 March 2022, at 06:27 (UTC).
 Text is available under the Creative Commons Attribution-ShareAlike License 3.0;
additional terms may apply. By using this site, you agree to the Terms of
Use and Privacy Policy. Wikipedia® is a registered trademark of the Wikimedia
Foundation, Inc., a non-profit organization.
 Privacy policy

 About Wikipedia

 Disclaimers

 Contact Wikipedia

 Mobile view

 Developers

 Statistics

 Cookie statement