Opened 7 months ago

Closed 2 weeks ago

#37007 closed Cleanup/optimization (fixed)

Extend contributor writing style section to counsel against the kinds of mistakes LLMs make

Reported by: Jacob Walls Owned by: Jacob Walls
Component: Documentation Version: dev
Severity: Normal Keywords: ai, llm, slop
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Per ​forum discussion, add a few sentences to the contributor writing style section with concrete guidance about how to maintain the "voice" of the documentation.

This will allow reviewers to more simply reject & redirect contributors submitting LLM-y prose without getting into debates about whether LLM use is "permitted". More fundamentally, what's not permitted is polluting the voice of the documentation.

Change History (6)

comment:1 by Jacob Walls, 7 months ago

Has patch: set

​PR

comment:2 by Natalia Bidart, 7 months ago

Triage Stage: Unreviewed → Accepted

Thank you!

comment:3 by Jacob Walls, 7 months ago

Patch needs improvement: set

comment:4 by Jacob Walls, 6 months ago

Patch needs improvement: unset

comment:5 by James Beard, 3 weeks ago

Triage Stage: Accepted → Ready for checkin

comment:6 by Jacob Walls <jacobtylerwalls@…>, 2 weeks ago

Resolution: → fixed
Status: assigned → closed

In 650fa4e:

Fixed #37007 -- Added "Voice" section to writing style docs.

At the time of writing, we are facing a flood of proposed documentation
edits driven by generative AI tools. In many cases, these proposals need
significant redirection to maintain consistency with the voice of
Django's documentation.

See ​https://forum.djangoproject.com/t/discouraging-the-voice-from-nowhere-llms-in-documentation/44699

Thanks Tim Schilling, Mike Edmunds, Tim Graham, Natalia Bidart, Sarah
Boyce, James Beard, and several others for valuable feedback.

Co-authored-by: Daniele Procida <daniele@…>

Note: See TracTickets for help on using tickets.
Back to Top