I could help extend the documentation

[oscherler]

When I started using psutils, I struggled a bit with some of the man pages, especially for the arguments to psnup and psbook. Also, I think it’s a bit of a pity that the Read Me doesn’t explain what tools are available and what they do.

If I try to work on this, would you be interested, and possibly available to give a few clarifications if needed?

P.S.: I’m not going to use any AI for that, in case it’s a concern. Just authentic, handcrafted technical writing.

[rrthomas]

I'd love that! The man pages have changed relatively little in 30 years. I have tried to add clarifications and fixes, but that's about it.

I am very happy to help.

The one thing I would say up front is that I don't like duplication (because it turns into inconsistency), and that applies to documentation as much as code.

So I think that what would be ideal extra material would be very much, as I think you're suggesting, something to expand the first paragraph of the README. A list of the tools with a short section on what each does would be great; I just wouldn't want usage information.

Having said that, something more like a cookbook would be fine, as that would be relatively straightforward to check and update if the programs changed. (Also at this point the command-line interface is pretty much set in stone, or at least, can't change in a backwards-incompatible way).

Authentic writing very welcome!