top | item 31706485

(no title)

carlisle_ | 3 years ago

For updating internal documentation? I think we should be careful to ensure we’re actually adding value when we add friction, and not just hoping.

discuss

order

mr-ron|3 years ago

What is the scope of this documentation change? Is this a quick edit, or is this a whole new tutorial for new engineers getting their stack up? How long is this going to take?

Do you want an engineer every standup saying 'im working on documentation' without any accountability?

carlisle_|3 years ago

You really want to add friction to completing those tasks? How long does it really take to complete any one of those things, and how is a ticket going to change the fact it probably needs to get done anyway? Why am I going to write a ticket for docs I can write in an hour and be done with? Why would you want the docs to stay out of date until a ticket is created, rather than just fixing them?

Frankly I think you missed the point of the article. If you don’t trust your engineers to prioritize their own time when it comes to writing documents, you don’t trust them to do anything. You’re exactly a part of the problem that Will is talking about.

sanderjd|3 years ago

The original scope that started this thread was "a quick edit". The claim is (or seems to be) that it is not too much friction to require a ticket for everything, which would necessarily include these small edits. That's stupid and will discourage small edits, which is bad, is what people are saying here.

> Do you want an engineer every standup saying 'im working on documentation' without any accountability?

Yes? It isn't any of my business, unless I'm that person's manager, in which case I'll certainly use my 1:1 with that engineer to understand what the documentation changes they're making are all about, and if it seems like a poor use of time then I'll give them a nudge. But if I'm anyone else in this situation, I'll certainly mind my own business.

treis|3 years ago

I'm sure talking about having to update internal documentation has value. Can you perhaps elaborate on why 2 minutes to write a ticket is such a burden?

synu|3 years ago

Let’s first open a ticket to have a discussion about the ticket opening process, and from there we can get a ticket open to open your proposed ticket.

ipaddr|3 years ago

Can you fill out this form in triplet?

carlisle_|3 years ago

Can you explain why it’s necessary I need to write a ticket to update documentation?

sanderjd|3 years ago

Oof, if this really needs to be explained, boy I just really don't know...