Add a list of good documentation examples or guidelines

[BOLT04]

Inspiration
Most of us tend to agree that our documentation writing skills aren't the best. But what makes good documentation? What are some examples we could look up to? How can we improve on this area?

Description

This idea was discussed a bit on some streams (e.g. Web security for web developers with Zaproxy by Simon Bennetts here and here).

This list could be in the README of this repo, for example.

Let me know your thoughts on this idea, and if documentation is something you are interested in learning more about 😃

[github-actions]

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community 🤓

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

[eddiejaoude]

Great idea @BOLT04 👍

[github-actions]

Stale issue message

[eddiejaoude]

We still need this stalebot 🤓

I was even thinking of taking it a step further and making a video for each documentation, what do people think?

[BOLT04]

awesome idea @eddiejaoude, but would it be like checking out good examples of documentation in open source repos? That could be very cool indeed and then if we get a good collection of examples, we might be able to produce a .md file on this repo for a quick guide on writing good documentation (in general and then perhaps specific to OSS) 😃

[eddiejaoude]

The more I think about it, both are needed - some documentation on how to write good documentation with examples and a video about it too.

I have made lots of notes. I should do the docs first as it will be easier and quicker - plus can get reviewed and improved before I do a video on it

[BOLT04]

hi @eddiejaoude 😃, i was thinking about this topic and I think I found some examples of good documentation:

• https://stripe.com/docs
• https://developer.github.com/v3/guides/getting-started/
• https://github.com/thegooddocsproject (I believe I saw this on my feed because you starred it 😃 )

Let me know what you think and if this is useful for the notes you already have 👍 .

[eddiejaoude]

@BOLT04 looks good 👍 , I think this makes a great start to a doc to be honest! Then we can keep tweaking it from there, especially as we get more feedback from people 🤓

[github-actions]

Stale issue message

[github-actions]

Stale issue message

[BOLT04]

I think we can reopen this since it can still provide value to people that want to know more about writing good documentation.
@eddiejaoude did we end up creating a markdown file or a video for this already?

[eddiejaoude]

Not yet @BOLT04 , thank you for reopening

I think once someone starts, others will continue. You listed some great docs already, those are good starting point 👍

[schmelto]

What about opening a github discussion for this?

[waellerbe]

Inspiration Most of us tend to agree that our documentation writing skills aren't the best. But what makes good documentation? What are some examples we could look up to? How can we improve on this area?

Description

This idea was discussed a bit on some streams (e.g. Web security for web developers with Zaproxy by Simon Bennetts here and here).

This list could be in the README of this repo, for example.

Let me know your thoughts on this idea, and if documentation is something you are interested in learning more about 😃

I have an interest in documentation, and I welcome the opportunity to contribute to this part of of the project. Let me know how I can assist.

[eddiejaoude]

@waellerbe have a look at one of our active projects like BioDrop, there are always improvements to be made https://github.com/EddieHubCommunity/BioDrop

[waellerbe]

@waellerbe have a look at one of our active projects like BioDrop, there are always improvements to be made https://github.com/EddieHubCommunity/BioDrop

Thank you @eddiejaoude for the recommendation. I plan to spend more time with BioDrop. My appreciation for the community grows with each new day.