Jerod
๐ค SpeakerAppearances Over Time
Podcast Appearances
And now if you are then past that phase and you're trying to understand it at a deeper level or learn about it, we have like specific docs for that. And then if you get past, you've already chosen it, right? You kind of get it. Help me explore all of the different areas of this library, for instance.
And now if you are then past that phase and you're trying to understand it at a deeper level or learn about it, we have like specific docs for that. And then if you get past, you've already chosen it, right? You kind of get it. Help me explore all of the different areas of this library, for instance.
And so it's kind of like formatting documentation or thinking about it from that perspective versus kind of our traditional way of writing docs. Just off the top of your head, is this attractive to you? Do you think this is doomed to fail? Do you think this is potentially interesting? What are your thoughts?
And so it's kind of like formatting documentation or thinking about it from that perspective versus kind of our traditional way of writing docs. Just off the top of your head, is this attractive to you? Do you think this is doomed to fail? Do you think this is potentially interesting? What are your thoughts?
Yeah, and then reference, of course, is there. We already do reference somewhat well. I mean, that's kind of one of the things that we do is reference docs, where it's like, here's my API, here's all of the names, and here's how you call these things and the options you can set. But that's a very small sliver of all the things. You're kind of at the end of it at that point.
Yeah, and then reference, of course, is there. We already do reference somewhat well. I mean, that's kind of one of the things that we do is reference docs, where it's like, here's my API, here's all of the names, and here's how you call these things and the options you can set. But that's a very small sliver of all the things. You're kind of at the end of it at that point.
You're like, okay, now I'm just referencing the exact details of how I use a particular thing. But I agree with you that once I get past appraisal, oftentimes, and I want to learn more about a library, I just end up writing the source code. Not writing the source code, I end up right in the source code. Because it's like, and I have no idea. I mean, that's usually how you get it figured out.
You're like, okay, now I'm just referencing the exact details of how I use a particular thing. But I agree with you that once I get past appraisal, oftentimes, and I want to learn more about a library, I just end up writing the source code. Not writing the source code, I end up right in the source code. Because it's like, and I have no idea. I mean, that's usually how you get it figured out.
You're like, okay, there's probably a main function somewhere. And then like, okay, I can see their imports or where they're includes. And I start following that little rabbit trail.
You're like, okay, there's probably a main function somewhere. And then like, okay, I can see their imports or where they're includes. And I start following that little rabbit trail.
And eventually I feel like I get some knowledge, but man, the most basic of handholding, you know, like a paragraph that said like, here's how I'm laid out would like time warp me, you know, hours probably into understanding. So good point.
And eventually I feel like I get some knowledge, but man, the most basic of handholding, you know, like a paragraph that said like, here's how I'm laid out would like time warp me, you know, hours probably into understanding. So good point.
He says the order of the actions, and that's the order that I read them in, is intentional, but it's not strict. So it's not that you couldn't jump. Maybe you've appraised it. It's pretty simple. You understand it. You just go straight to like troubleshooting, you know? So he did put them in like an order that he thought made a lot of sense, but it's not like you must do them in this order.
He says the order of the actions, and that's the order that I read them in, is intentional, but it's not strict. So it's not that you couldn't jump. Maybe you've appraised it. It's pretty simple. You understand it. You just go straight to like troubleshooting, you know? So he did put them in like an order that he thought made a lot of sense, but it's not like you must do them in this order.
Gotcha. Okay.
Gotcha. Okay.
So get out there and write that paragraph, y'all.
So get out there and write that paragraph, y'all.
Especially like, I mean, I joke about that. In the small, you know, a five-line function can certainly be self-documenting as long as it's simple enough. But your architecture that lives in your head and the head of your team, that's the only place it lives. I mean, obviously there's a call stack, so it lives there as well. But... it takes one person a half an hour maybe to write that paragraph.
Especially like, I mean, I joke about that. In the small, you know, a five-line function can certainly be self-documenting as long as it's simple enough. But your architecture that lives in your head and the head of your team, that's the only place it lives. I mean, obviously there's a call stack, so it lives there as well. But... it takes one person a half an hour maybe to write that paragraph.