Menu
Sign In Search Podcasts Charts People & Topics Add Podcast API Blog Pricing

Jerod

๐Ÿ‘ค Speaker
2134 total appearances

Appearances Over Time

Podcast Appearances

I also am skeptical of this, but I think you do want something in between I'm telling a machine what to write in common language, English, or whatever language you speak, and it is executing code on a CPU.

I also am skeptical of this, but I think you do want something in between I'm telling a machine what to write in common language, English, or whatever language you speak, and it is executing code on a CPU.

Well, not when I read my own code. Do I think it's natural language? I'm always like, what was this dork trying to say? And that's what comments are for. Yeah, exactly. Oh, you know, my code doesn't have any comments because it's self-documenting, Matthew. So I don't need, I dismiss with such nuance. Just read the code, man. It says what it does. Oh yeah, I'm sure.

Well, not when I read my own code. Do I think it's natural language? I'm always like, what was this dork trying to say? And that's what comments are for. Yeah, exactly. Oh, you know, my code doesn't have any comments because it's self-documenting, Matthew. So I don't need, I dismiss with such nuance. Just read the code, man. It says what it does. Oh yeah, I'm sure.

That reminds me of something my oldest son said one time, who we will never let him live down. And we make fun of him all the time. I asked him what a specific sentence meant or something. We're like in, you know, in schooling. And he says, it means what it says. That was his response. What does interesting mean? Interesting means that something's interesting to me. It just means what it said.

That reminds me of something my oldest son said one time, who we will never let him live down. And we make fun of him all the time. I asked him what a specific sentence meant or something. We're like in, you know, in schooling. And he says, it means what it says. That was his response. What does interesting mean? Interesting means that something's interesting to me. It just means what it said.

You know what it said. That's what it means. So, you know, not how you get an A in any sort of context. Um, but while we're talking about writing and these kinds of things, I'm thinking with Chris, I was thinking about documentation because Chris is like gung ho on documentation and archiving librarian. He thinks that every company should have an archivist or a librarian.

You know what it said. That's what it means. So, you know, not how you get an A in any sort of context. Um, but while we're talking about writing and these kinds of things, I'm thinking with Chris, I was thinking about documentation because Chris is like gung ho on documentation and archiving librarian. He thinks that every company should have an archivist or a librarian.

He's convinced me that that's not, he hasn't convinced me that's true, but he at least convinced me that's a pretty good idea for people to consider. Um, And I was reading a post recently. I should have sent this to you guys beforehand so you could have thoughts prepared, but we'll just go ad hoc style. The seven action documentation model. I actually put this in ChangeLog News just yesterday.

He's convinced me that that's not, he hasn't convinced me that's true, but he at least convinced me that's a pretty good idea for people to consider. Um, And I was reading a post recently. I should have sent this to you guys beforehand so you could have thoughts prepared, but we'll just go ad hoc style. The seven action documentation model. I actually put this in ChangeLog News just yesterday.

A very interesting post by Fabrizio Ferry Benedetti.

A very interesting post by Fabrizio Ferry Benedetti.

about docs and I won't I'll spare you all the details Chris but what he proposes is that the way we write documentation as technical writers and with a lot of the tools that we have they're very much oriented not on the end user but on like the output of what you're trying to cover like almost like test coverage like you have to have this kind of thing this kind of thing this kind of thing

about docs and I won't I'll spare you all the details Chris but what he proposes is that the way we write documentation as technical writers and with a lot of the tools that we have they're very much oriented not on the end user but on like the output of what you're trying to cover like almost like test coverage like you have to have this kind of thing this kind of thing this kind of thing

And he proposes that instead we think about it what user actions the docs are meant to satisfy. He comes up with this seven action model, which goes like appraise, understand, explore, practice, remember, develop, and troubleshoot. And that's roughly the order that he thinks he should do it in. And so he thinks that we should organize docs around that. Oh, you got it in the chat already. Cool.

And he proposes that instead we think about it what user actions the docs are meant to satisfy. He comes up with this seven action model, which goes like appraise, understand, explore, practice, remember, develop, and troubleshoot. And that's roughly the order that he thinks he should do it in. And so he thinks that we should organize docs around that. Oh, you got it in the chat already. Cool.

So I was going to just send you the link, but Matthew already got you the link.

So I was going to just send you the link, but Matthew already got you the link.

I think that's kind of interesting as a person who reads a lot of docs, I definitely was very attracted to this idea of like, well, if I'm trying to appraise a tool or a library or what have you, it'd be really interesting if it actually like specifically said like, if you're appraising this thing, here's what you need to know.

I think that's kind of interesting as a person who reads a lot of docs, I definitely was very attracted to this idea of like, well, if I'm trying to appraise a tool or a library or what have you, it'd be really interesting if it actually like specifically said like, if you're appraising this thing, here's what you need to know.