Email or username:

Password:

Forgot your password?
Top-level
Ed W8EMV

@shauna @jrconlin @hyc @mhoye

I can think of a couple of categories of things beyond the core code itself that are needed for the long-term health of a project:

- an accurate and detailed man page
- a "getting started" guide that deals with building, installing, and running some kind of "hello world" code to validate the install
- architecture documents that describe how and when to use the code
- a conference presentation aimed at a knowledgable audience
- full-length book

Rare to get all.

2 comments
jr conlin replied to Ed

@w8emv @shauna @hyc @mhoye

I think it's also somewhat important to note scale. A tiny package used by a few folk probably doesn't need much more than what folk already do. This would probably not overburden that one guy in Nebraska.

Once a project "graduates", takes on devs, and grows in use, then documentation becomes more important, just like security updates. Large projects should help by reaching down to smaller ones that they depend on.

Go Up