Skip to content

Revise note descriptions to use imperative mood and remove pronouns#6880

Closed
Copilot wants to merge 3 commits intoritwika/release_notes_backfillfrom
copilot/revise-note-descriptions
Closed

Revise note descriptions to use imperative mood and remove pronouns#6880
Copilot wants to merge 3 commits intoritwika/release_notes_backfillfrom
copilot/revise-note-descriptions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 26, 2026

Note descriptions throughout the docs used pronouns (We, You, It, They) and indirect phrasing like "Customers can..." This makes documentation less direct and harder to scan.

Changes

Standardized note descriptions to start with feature nouns or action verbs:

  • "Customers can/will" → Direct feature descriptions
  • "We recommend" → Imperative verbs ("Store", "Use")
  • "You can" → Imperative or passive voice
  • "It/They" → Specific nouns ("This feature", "Names")
  • "We are in the process" → Passive voice ("Support is being added")

Example

Before:

> [!Note]
> We recommend storing database tokens in a **secure secret store**.

After:

> [!Note]
> Store database tokens in a **secure secret store**.

Before:

- **Query request rate dashboard:** Customers can view error rates (broken down by error type) and success rates for query requests.

After:

- **Query request rate dashboard:** View error rates (broken down by error type) and success rates for query requests.

Scope

96 files updated across InfluxDB 3, InfluxDB v2/v1, Telegraf, and shared content.

Original prompt

Revise note descriptions to start with a feature noun or verb. Remove pronouns and "Customers can"


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 26, 2026 17:33
…ctions

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copilot AI changed the title [WIP] Revise note descriptions to improve clarity Revise note descriptions to use imperative mood and remove pronouns Feb 26, 2026
@jstirnaman jstirnaman deleted the branch ritwika/release_notes_backfill February 27, 2026 15:18
@jstirnaman jstirnaman closed this Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants