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

Requesting a page: what makes a good request

AS
a.salcedoTL3Regular13 Feb 2025#1

Requesting a page: what makes a good request Writing it up because I had to work it out twice and would rather nobody else did.

Trying to work out what would count as evidence on requesting a page, before collecting any. This is the part I usually skip and it is the part that makes the rest useful.

If two explanations predict the same observation, observing it does not help. So: what observation would separate them?

46 likes 17mo
ME
me.eriksenTL216 Feb 2025#2

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.

Two people can read the same figure differently here and both be reasonable.

11 likes 17mo
FS
f.sjobergTL218 Feb 2025#3
a.salcedo, post #1: Requesting a page: what makes a good request Writing it up because I had to work it out twice and would rather nobody else did. Trying to work out what would count as evidence on requesting a page, before collecting any. This is the part I usually skip and it is the part that makes the rest useful. If two explanations predict the same… Go to post

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

1 like in reply to #1 17mo
DF
d.fontaineTL220 Feb 2025#4
f.sjoberg, post #3: Scope creep: if you think a page is attempting too much and should be split into multiple pages, that is a reasonable suggestion. Go to post

Adding the measurement that the opening post says would settle it.

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

0 likes in reply to #3 17mo
ML
m.lindqvistTL221 Feb 2025#5

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

If anyone has run this properly I would rather read that than my own guess.

33 likes 17mo
MM
m.malinowskiTL223 Feb 2025#6

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.

17 likes 17mo
CC
c.correiaTL224 Feb 2025#7

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

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 the shape of it. The detail is where I would expect to be corrected.

3 likes 17mo
RR
r.restrepoTL225 Feb 2025#8
c.correia, post #7: On post #5 — agreed on the reasoning, with one qualification. 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 the shape of it. The detail is where I would expect to be corrected. Go to post

Picking up post #5: that is the part I would want checked first.

A document with no maintainer becomes wrong quietly, which is worse than not existing, because it carries the authority of a maintained page.

Not a strong opinion, just a consistent one.

0 likes in reply to #7 17mo
JD
j.delacroixTL3Regular27 Feb 2025#9

A calculator request and a document request are different things, and a calculator without a document explaining it is worse than neither.

0 likes 17mo
RM
ra.mensaTL228 Feb 2025#10

If a request is declined, the reasoning is written down, and it is worth reading because it usually describes a better version of the same idea.

24 likes 17mo
SO
s.okaforTL21 Mar 2025#11
j.delacroix, post #9: A calculator request and a document request are different things, and a calculator without a document explaining it is worse than neither. Go to post

Post #10 is right about the mechanism and I think understates the practical bit.

Link the topics that prompted the request. The discussion is the evidence that the question recurs.

That is all the detail I have. Someone else will have more.

3 likes in reply to #9 17mo
LG
lc_gradientTL3Analytical chemist2 Mar 2025#12

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.

Someone will know this better than I do and I hope they say so.

10 likes 17mo
DV
d.vukovicTL23 Mar 2025#13

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.

30 likes 17mo
DB
dr_bhattacharyaTL3Physician5 Mar 2025#14

On post #12 — 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 am describing what is, rather than arguing for what should be.

0 likes 17mo
AN
a.novakTL26 Mar 2025#15

Appreciated. The plain phrasing does more work here than a longer post would.

6 likes 17mo
BN
bench_notesTL4 Moderator7 Mar 2025#16

I had written a reply contradicting post #12 and deleted it. Here is what survived.

The strongest case for a new document is a question that recurs and has a good answer buried in a reply. That is the promotion criterion as written.

Happy to expand any of that if it is the useful part.

15 likes 17mo
EV
e.vargaTL28 Mar 2025#17
RA
r.aldana_pharmdTL4Pharmacist9 Mar 2025#18
c.correia, post #7: On post #5 — agreed on the reasoning, with one qualification. 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 the shape of it. The detail is where I would expect to be corrected. Go to post

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.

1 like in reply to #7 17mo
IG
i.guerreroTL210 Mar 2025#19

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

0 likes 17mo
BW
bac_waterTL2Regular11 Mar 2025#20

Everything in post #16 holds. The case it does not cover is the one I have.

A request is more likely to succeed with a proposed outline attached. "Somebody should write about X" rarely moves; a structure and two sections does.

Stating my assumptions rather than smuggling them in.

3 likes 17mo
AS
a.salcedoTL3Regular12 Mar 2025#21
ra.mensa, post #10: If a request is declined, the reasoning is written down, and it is worth reading because it usually describes a better version of the same idea. Go to post

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

12 likes in reply to #10 17mo
NN
n.nakamuraTL213 Mar 2025#22

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

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

4 likes 17mo
EO
e.okaforTL214 Mar 2025#23

Post #21 put the caveat in the right place and I want to underline it.

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

Worth one more sentence than it usually gets.

0 likes 16mo
AS
a.sorensenTL215 Mar 2025#24
e.varga, post #17: 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. 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.

Small point, but it is the one that usually catches people.

0 likes in reply to #17 16mo
SS
stopper_shiftTL1Member16 Mar 2025#25
dr_bhattacharya, post #14: On post #12 — 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 am describing what is, rather than arguing for what should be. Go to post

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

17 likes in reply to #14 16mo
TV
to.vargaTL217 Mar 2025#26

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

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

On reflection I would soften that slightly.

7 likes 16mo
J
JFitzgibbonTL2Member18 Mar 2025 · edited#27

Where a request is for a translation or a regional version, the maintenance burden doubles and the proposal should say who carries it.

If that reads as pedantic, it is, and it has saved me twice.

1 like 16mo
ND
n.dziedzicTL219 Mar 2025#28

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

A modest claim, modestly supported.

0 likes 16mo
HK
h.kjeldsenTL1Member20 Mar 2025#29

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.

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

24 likes 16mo
MN
m.ndiayeTL221 Mar 2025#30

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

I have changed my mind on this once already, so take it as current rather than settled.

11 likes 16mo