DEV Community

Discussion on: Software Documentation, how can we do better?

Collapse
 
ardennl profile image
Arden de Raaij

Hi Elsa, That's great! I think it's such an undercurrent because we often come across these problems. This post is not so much on writing my own documentation as it is about an over complicated learning curve for our favorite tools because documentation is conflicting.

Regardless, these resources are a good help though and might help in contributing to better documentation in open source software.

Another thought, would you think it to be okay to ask someone who blogged about a topic to update their article or add a note that something is out of date?

Collapse
 
gonsie profile image
Elsa Gonsiorowski

I think its okay to ask someone to update an article they wrote. Some tools/processes change quickly, while others are very stable. Sometimes (if the original author has moved on from a particular tool) it can be useful to write your own post on how transition a project from an old tool to a new one.