Maintain consistent formatting and style when documenting telemetry and observability systems. This includes using parallel structure in lists, consistent terminology, and clear explanations of what data is collected and why.
When documenting telemetry collection, ensure:
Example of inconsistent vs consistent formatting:
// Inconsistent
- What command is used as the entrypoint?
- Package manager being used (e.g. npm, yarn)
- Number of first time downloads
// Consistent
- Command used as entrypoint
- Package manager (e.g. npm, yarn)
- Whether instance is a first-time download
This ensures that observability documentation is professional, clear, and maintains user trust by transparently communicating monitoring practices.
Enter the URL of a public GitHub repository