4 ms·
Culturally at GitLab we use numbered lists so that it makes it easy to link and reference someone to a spot on the page. see https://about.gitlab.com/handbook/
by lbotos 5y ago
Culturally at GitLab we use numbered lists so that it makes it easy to link and reference someone to a spot on the page.
see https://about.gitlab.com/handbook/communication/#writing-style-guidelines https://about.gitlab.com/handbook/communication/#writing-sty... number 13:
If you have multiple points in a comment or email, please number them. Numbered lists are easier to reference during a discussion over bulleted lists.
- gravy 5y agoLove the meta
- po 5y agoInteresting. With editable docs, things sometimes get added above the points or reordered and then re-numbered which makes the discussion misleading. The reason I prefer bullets is that it encourages people to quote the relevant section when discussing.
- airstrike 5y agoIs #28 mixing up sending and receiving? >28. If an email needs a response, write the answer at the top of it. Alternatively, it feels like it could read: > If an email includes a response, place it at the top of it. If an e-mail requires a response, also make that clear at the very top.
- randallsquared 5y agoThe judgement about whether an email needs a response is left to the receiver who would be responding, in their statement. I like that mental model of things. :)
- airstrike 5y agoThat leaves room for miscommunication, though. If someone expects a response from me, I'd rather they make sure to ask it at the very top so that I don't miss that request with everything else that's going on. Re-reading the statement, maybe they simply mean replies should be above the original e-mail rather than inline?
- randallsquared 5y agoI believe that's what they intended to convey, yes.