docs-style

# Documentation Style Guide Apply these principles when writing or reviewing documentation to ensure clarity, consistency, and accessibility for both human readers and LLMs. ## Voice and Tone ### Use Second Person Address the reader directly as "you" rather than "the user" or "developers." ```markdown <!-- Good --> You can configure the API by setting environment variables. <!-- Avoid --> The user can configure the API by setting environment variables. Developers should configure the API by setting environment variables. ``` ### Prefer Active Voice Write sentences where the subject performs the action. Active voice is clearer and more direct. ```markdown <!-- Good --> Create a configuration file in the root directory. The function returns an array of user objects. <!-- Avoid --> A configuration file should be created in the root directory. An array of user objects is returned by the function. ``` ### Be Concise Cut unnecessary words. Every word should earn its place. ```markdown <!-- Good --> Run the install command. <!-- Avoid --> In order to proceed, you will need to run the install command. ``` ```markdown <!-- Good --> This endpoint returns user data. <!-- Avoid --> This endpoint is used for the purpose of returning user data. ``` Common phrases to simplify: | Instead of | Use | |------------|-----| | in order to | to | | for the purpose of | to, for | | in the event that | if | | at this point in time | now | | due to the fact that | because | | it is n...