Knowledgebase

Writing Tests and Documentation Print

  • zillionkinghostai, troubleshooting, guide, howto, solution, zillionkinghost, hosting, support
  • 0

The work people skip.

FOR TESTS

"Write tests for this. Cover the normal case, the edge cases, and failure."

Generated tests are a starting point. Check they actually test something.

THE COMMON PROBLEM

Tests that pass whatever the code does. A test asserting a variable exists rather than that a behaviour happens.

Check each test would fail if the code were wrong.

FOR DOCUMENTATION

"Write documentation for this. Reader: [who]. Include what it does, how to use it, what it requires, and what can go wrong."

WHY THIS IS A GOOD USE

Documentation is the work that never rises to the top of the list.

Generating a first draft makes it happen.

WHAT TO VERIFY

Every example, by running it Every claim about behaviour

FOR README FILES

"Write a README covering installation, configuration, usage and troubleshooting."

Then correct it against what the software actually does.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot