2024 Documentation Article draft for bssw blog

[fryeguy52]

By making a submission here, you agree to BSSw.io content licensing terms.

You are welcome to submit an idea for an article or a completed article.

After your submission is received, it will be reviewed by the BSSw.io editorial staff and we will be in touch with you.

If BSSw.io editorial staff decide to move your submission forward, a checklist of additional actions to take to complete the publication process may be pasted here.

@jwillenbring @bernhold

[bernhold]

Hi @fryeguy52, I know it has been a while, but we're preparing to publish your blog article at the end of the month. I've taken an initial editorial pass through the article, making changes in varying degrees. One of the more significant ones was to suggest changing the title to something like "How Investing in Documentation Makes Even a Single-Developer Project Better". I thought this better characterized the point of your article. But we can go back to your title (or something else if you prefer).

There are a few things I need your help with, however:

1. Do you have a link to the NLIT slides you mention? I couldn't find them with Google searching.
2. On line 29 of the file, you have an incomplete sentence. I've marked it with a bunch of question marks ("?????") to help point it out. Can you help complete it?
3. The first half of the article is in the third person (we), and then you shift to first person (I). Is the "we" part really you, perhaps in occasional discussion with colleagues? Or was it really a team of people? I think we probably need to either unify on one voice or say a little more to explain the transition. Thoughts on what would be the best approach?
4. We need a short bio for you -- 50-100 words is fine. You can look at other blog articles on the BSSw.io site to get a feel, but it is the usual thing.

I'd really appreciate it if you could respond this week, either by updating the PR or by letting me know what you'd like to do and I can help.

Thanks

[fryeguy52]

@bernhold Thanks for the feedback. I made a commit with the changes to the text you requested. NLIT does not have the links active to the 2024 presentation slides anymore. Is there a way to make it available on the blog? I have a ppt or pdf?

[bernhold]

Thanks @fryeguy52 ! I should have time to work on this this afternoon.

Unfortunately, we don't have any way of serving PDFs from our site. I often use FigShare.com to archive a document that I want to be able to share. The service is archival, and they'll mint a DOI for each record you create.