Prompt
When using automated tools to generate documentation, always verify the output for accuracy and document any additional manual steps required for completion. Automated documentation can inherit incorrect properties or miss crucial steps in the process.
For example:
- When running tools like
rake docs_site:resourcesthat generate resource documentation automatically, review the output to ensure resources that inherit from parent resources don’t contain properties or actions that don’t apply to them. - When using scripts like
publish-release-notes.shthat push content to repositories, document the complete process including any subsequent manual steps (like triggering Netlify rebuilds) required for the documentation to become visible to users.
Document both the automation commands and their limitations to ensure team members understand the complete documentation workflow. This prevents confusion and ensures accurate, complete documentation reaches the end users.