Everyone knows that quite a few KDE application manuals have never been written, and the quality of the writing on some that have been written is, to put it gently, not the most superlative. Part of the problem, as I see it, is that obtaining good documentation for an application requires three different kinds of knowledge:
1. Specific and detailed knowledge of how the application works.
2. Knowledge of the conventions for writing KDE documentation.
3. Knowledge of how to write clear and understandable documents.
The difficulty is that there may be people around who have one or two of these but not the third.
I've done a great deal of technical writing, and I believe the documents I produce are of excellent quality. I also know that there are often calls for help in this area. I wonder if there's any way I can put my abilities to use here, given that I don't usually have Type 1 or Type 2 knowledge. More generally, is there some way that documentation teams might combine different abilities?
1. Specific and detailed knowledge of how the application works.
2. Knowledge of the conventions for writing KDE documentation.
3. Knowledge of how to write clear and understandable documents.
The difficulty is that there may be people around who have one or two of these but not the third.
I've done a great deal of technical writing, and I believe the documents I produce are of excellent quality. I also know that there are often calls for help in this area. I wonder if there's any way I can put my abilities to use here, given that I don't usually have Type 1 or Type 2 knowledge. More generally, is there some way that documentation teams might combine different abilities?
Comment