Stefan Seyfried wrote:
On 08.08.21 15:34, jdd@dodin.org wrote:
In a doc, there should not be any "context specific" that is not immediately obvious, so you can change it asap.
One example: You document a workaround to get something working (let's say your bluethooth adapter).
As an example, I would suggest my brief amendment of the article on how to read 1-wire devices on an ARM board.
One year later, I come around and find that I do not need your work around to get bluetooth working. But was it fixed over time or is it just that my (slightly different) hardware does not need the workaround yours needs?
When you are so involved anyway, you will probably know, and be able to update the article ?
The easiest way would be to ask the original author of the hint.
He may have no idea about your (slightly different) hardware.
Finding this person easily is a good thing.
Which the wiki supports.
Now I am mostly a developer type of guy, means: I don't really need that documentation. If something does not work, in the worst case, I just look up the problem in the source code ;-)
There are times when it is not exactly easy. Figuring out how to change a DTB for your ARM board is not for the faint hearted. Documentation is needed. At least for us lesser developers :-) -- Per Jessen, Zürich (20.7°C) Member, openSUSE Heroes