Documentation should prioritize clarity and actionable guidance over comprehensive coverage. Organize content logically by placing the most relevant information first, provide clear recommendations on preferred approaches, and avoid unnecessary complexity or redundant details that don't add value.
Documentation should prioritize clarity and actionable guidance over comprehensive coverage. Organize content logically by placing the most relevant information first, provide clear recommendations on preferred approaches, and avoid unnecessary complexity or redundant details that don’t add value.
Key principles:
Example of good practice:
:::note
The `context.tracing` API records different information than the automatic tracing enabled through [Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace). For most use cases, you should use the configuration option instead as it captures both browser operations and test assertions.
:::
This approach ensures documentation serves as an effective guide rather than just a comprehensive reference, helping users make informed decisions quickly.
Enter the URL of a public GitHub repository