influxdata / influxdata/docs-v2

Phase 3 AI visibility: ongoing editorial discipline

Open
#7,234 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

InfluxDB v3 Long-term platform
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

## Goal

Maintain AI-visibility wins after Phases 0–2 ship. These are editorial habits and recurring rituals, not one-shot tasks. This issue tracks the cadence; specific editorial fixes get their own issues.

Parent: #7230

## Ongoing practices

- [ ] **Reach for the chosen sharing mechanism before writing duplicate prose.** Whichever route Phase 2 picks (transclusion, stub-linking, or hybrid), reinforce it in PR review until it's instinctive
- [ ] **Deep-link by anchor when linking to reference.** Link to `/reference/api/write/#authentication`, not `/reference/api/write/`. Pure editorial discipline, no engineering cost
- [ ] **Quarterly content freshness reviews** on the top 50 pages by traffic. Refresh "Last Updated" dates, version numbers, and any stats that drift
- [ ] **Quarterly prompt audits** — re-test 5–10 priority prompts in plain mode (no browsing) and RAG mode (with browsing) across ChatGPT, Claude, Gemini, Perplexity. Track mention rate, position, citation quality, sentiment, and delta by use case (IIoT/BESS vs. generic monitoring vs. fintech). Feed results back into Phase 0/1/2 backlogs
- [ ] **Lint discipline** if Phase 2 ships `ref-include`: CI flags prose patterns that should come from fragments (e.g., literal `Authorization: Bearer` outside `_shared/` and `/reference/`)

## Cadence

- Quarterly: prompt audits, top-50 freshness review
- Continuous: PR-review reinforcement of the chosen sharing mechanism and anchor-deep linking

## Out of scope

- One-shot fixes (open their own issues)
- Measurement tooling (lives in `influxdata/docs-tooling`)
- The prompt-audit data pipeline itself (lives in `influxdata/docs-tooling`)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with parent issue #7230 and review the decisions from Phases 0–2, especially the Phase 2 sharing mechanism. The work is ongoing rather than a single change: done means maintaining the stated editorial practices and quarterly reviews, while feeding audit results into the Phase 0/1/2 backlogs.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.