The Peptide CommonsEst. May 2024
Independent. We sell nothing and are affiliated with no manufacturer or pharmacy. Every moderation action is logged in public
Documentation · Wiki requests

A page that has drifted out of date and needs a maintainer

Solved
Solved by outline_first in post #2
Worth separating two things that the opening post runs together. Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change.

Jump to the accepted answer →

TI
trough_indexTL3Regular4 Aug 2024#1

On the subject in the title: A page that has drifted out of date and needs a maintainer Working notes rather than a conclusion.

Nominating something for promotion into the documentation commons.

The topic in question keeps being re-asked, has a good marked solution, and contains a worked example that would be more useful on a page with a review date than buried in a reply. That is exactly the promotion criterion as written.

Objections welcome and genuinely wanted — the whole point of discussing promotions in public is that a bad promotion is harder to undo than a bad reply.

22 likes 2y
OF
outline_firstTL3Wiki editor Solution12 Aug 2024#2

Worth separating two things that the opening post runs together.

Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change.

25 likes 2y
SV
s.vukovicTL217 Aug 2024#3

Objections to a request belong in the open, and a request that survives an objection is a stronger page for it.

The step people skip is the one I have spelled out.

0 likes 23mo
NE
n.ekstromTL2Regular22 Aug 2024#4
trough_index, post #1: On the subject in the title: A page that has drifted out of date and needs a maintainer Working notes rather than a conclusion. Nominating something for promotion into the documentation commons. The topic in question keeps being re-asked, has a good marked solution, and contains a worked example that would be more useful on a page with… Go to post

Review cadence should be part of the proposal. A page about a fast-moving area needs a shorter cycle and somebody willing to honour it.

The conclusion is tentative; the arithmetic underneath it is not.

1 like in reply to #1 23mo
VR
v.rautioTL227 Aug 2024#5

Requests for a page summarising a supplier are declined, because that is what the vendor documentation set is for and it has its own standards.

That is the honest state of it as of this week.

17 likes 23mo
B
BirkelandTL3Regular31 Aug 2024 · edited#6

On post #4 — agreed on the reasoning, with one qualification.

Say what would make the page wrong. A page whose failure conditions are stated is much easier to review honestly.

I checked the source rather than the summary, and they differ.

33 likes 23mo
GA
g.amankwahTL24 Sep 2024#7

Request a new maintained page: if a question recurs, has a good marked solution, and contains a worked example, it is a candidate for promotion to a maintained documentation page. Post your nomination in this subcategory with a link to the topic.

0 likes 23mo
CT
cannula_traceTL3Regular8 Sep 2024#8
g.amankwah, post #7: Request a new maintained page: if a question recurs, has a good marked solution, and contains a worked example, it is a candidate for promotion to a maintained documentation page. Post your nomination in this subcategory with a link to the topic. Go to post

A page that would need to be rewritten every quarter is usually better as a topic with a good marked solution.

It is the kind of thing that is obvious once and never again.

4 likes in reply to #7 23mo
HA
h.agyemanTL212 Sep 2024#9

Suggesting content for a page: if you know a maintained page is missing something important, post a suggestion with specific content you think should be added.

I would put the burden of proof on the interesting explanation, not the dull one.

24 likes 23mo
DH
dietitian_hollisTL3Dietitian16 Sep 2024#10

Flag a page that has drifted: if you notice a maintained page has information that is outdated (dates that have passed, regulatory changes, new evidence) post a flag so the maintainers see it.

Marking that as an opinion rather than a finding.

0 likes 22mo
EM
e.mikkelsenTL2Member20 Sep 2024#11

Correction requests: if you spot an error in a maintained page, note it here with the specific correction. The maintainer will review and update if justified.

I would be interested in a counterexample if anyone has one.

14 likes 22mo
DN
d.nwosuTL223 Sep 2024 · edited#12

The arithmetic in post #11 is right; the assumption feeding it is the part to check.

The most useful requests here identify a specific confusion that keeps recurring rather than a subject that seems important.

5 likes 22mo
SP
s.poulsenTL3Regular27 Sep 2024#13
d.nwosu, post #12: The arithmetic in post #11 is right; the assumption feeding it is the part to check. The most useful requests here identify a specific confusion that keeps recurring rather than a subject that seems important. Go to post

Good question, well framed, and I would like to see it answered properly.

0 likes in reply to #12 22mo
ET
e.tammTL230 Sep 2024#14
dietitian_hollis, post #10: Flag a page that has drifted: if you notice a maintained page has information that is outdated (dates that have passed, regulatory changes, new evidence) post a flag so the maintainers see it. Marking that as an opinion rather than a finding. Go to post

Translation suggestions: if a maintained page should exist in another language, suggesting it here helps the maintainers prioritise multilingual work.

That holds for the case as described. Change the assumptions and it may not.

28 likes in reply to #10 22mo
M
MSaarinenTL33 Oct 2024#15
EK
e.krastevTL27 Oct 2024 · edited#16

Narrowing post #14, because the general version has more than one answer.

Format suggestions: if you think a maintained page could be clearer in its presentation (different section structure, different examples, added graphics) suggest the change.

2 likes 22mo
V
VThorvaldsenTL3Regular10 Oct 2024#17

Accessibility feedback: if you have trouble accessing or reading a maintained page (screen reader issues, contrast problems, small text) report it. Accessibility matters.

That is one dataset and I would not build a rule on it.

0 likes 22mo
IR
i.rasmussenTL213 Oct 2024#18
MSaarinen, post #15: Everything in post #11 holds. The case it does not cover is the one I have. Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change. Go to post

The most useful requests here identify a specific confusion that keeps recurring rather than a subject that seems important.

The answer changed when I changed how I was measuring, which was informative.

21 likes in reply to #15 21mo
K
KnowltonTL3Regular16 Oct 2024#19

Scope creep: if you think a page is attempting too much and should be split into multiple pages, that is a reasonable suggestion.

I looked this up rather than remembered it, which is the right order.

27 likes 21mo
IB
i.brobergTL220 Oct 2024#20
MSaarinen, post #15: Everything in post #11 holds. The case it does not cover is the one I have. Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change. Go to post

Authority and authorship: if you think a maintained page needs input from someone with specific expertise (a clinician, an analytical chemist) suggest who might contribute.

If it helps: the failure mode here is usually boring rather than dramatic.

13 likes in reply to #15 21mo
TK
t.karlsenTL223 Oct 2024#21
outline_first, post #2: Worth separating two things that the opening post runs together. Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change. Go to post

Name a willing maintainer in the request. Point three of the criteria stops more nominations than the other three combined.

I would hold that lightly until someone with a larger sample weighs in.

8 likes in reply to #2 21mo
NE
n.ekstromTL226 Oct 2024#22
CC
c.castellanosTL229 Oct 2024#23

I came in to disagree and I am leaving without a disagreement.

0 likes 21mo
YM
y.mensahTL3Wiki editor1 Nov 2024#24
VThorvaldsen, post #17: Accessibility feedback: if you have trouble accessing or reading a maintained page (screen reader issues, contrast problems, small text) report it. Accessibility matters. That is one dataset and I would not build a rule on it. Go to post

Scope the request narrowly. A page about one thing gets written and stays current; a page about a field does not.

This is the sort of thing that ought to be settled and apparently is not.

0 likes in reply to #17 21mo
RM
r.mensahTL24 Nov 2024#25
c.castellanos, post #23: I came in to disagree and I am leaving without a disagreement. Go to post

A request that says what the page should not cover is unusually helpful, because scope creep is what kills these.

I would not lead a decision with this, but I would not ignore it either.

13 likes in reply to #23 21mo
BJ
b.jankowiakTL3Regular7 Nov 2024#26

Documents that are mostly a worked example age better than documents that are mostly a summary, because the arithmetic does not change.

A guess, clearly labelled as one.

27 likes 21mo
PD
p.dialloTL210 Nov 2024#27

Adding the measurement that post #24 says would settle it.

Accessibility feedback: if you have trouble accessing or reading a maintained page (screen reader issues, contrast problems, small text) report it. Accessibility matters.

0 likes 21mo
B
BirkelandTL3Regular13 Nov 2024#28

Post #26 describes the usual case. This is about the unusual one.

Format suggestions: if you think a maintained page could be clearer in its presentation (different section structure, different examples, added graphics) suggest the change.

That is the practical version. The rigorous version is longer and says the same thing.

2 likes 20mo
NK
n.kuuselaTL215 Nov 2024#29

Taking post #28 at face value and following it one step further.

The most useful requests here identify a specific confusion that keeps recurring rather than a subject that seems important.

19 likes 20mo
NA
n.abernathyTL3Analytical chemist18 Nov 2024#30

Review cadence should be part of the proposal. A page about a fast-moving area needs a shorter cycle and somebody willing to honour it.

Adding it because I spent an afternoon working it out and nobody should have to twice.

0 likes 20mo