Document an interface
Explain how a library, CLI or API actually works.
What to have ready
- Scoped interface/version, checkout or excerpts, and documentation destination/ownership conventions.
When you run it
- Running examples needs the supplied code and suitable isolated project runtime; source-grounded unexecuted examples remain supported.
A task to start with
Explain a small public interface for the person who will call it.
An illustrative request
Use the interface-documentation workflow on the supplied exports or commands. Describe actual signatures, validation, results and relevant failure behavior. Separate executed examples from source-grounded but unrun ones.
How to check the result
Compare each documented public item with actual exports, callers and examples. Run examples only in an appropriate environment.
This preview explains the task and checking approach. It is not a demonstrated customer outcome or a guarantee.
See what a useful orientation looks like.
The free worked example includes source files, an actual entry-point trace and executed checks you can compare with the code.
Open the worked example