feat: Types of documentation

[BekahHW]

This kind of overlaps with multiple sections, so I'm happy to take feedback here. But I think there are different types of documentation.

So far, we cover readmes, cocs, contributing files. I think this section can talk about more technical aspects of documentation. We can cover some of the stuff here, but also talk about

• User Documentation: Guides, tutorials, and FAQs for end-users.
• API Documentation: Detailed information about the APIs, for developers who want to use or integrate with your project.
• Developer Documentation: This includes setup guides, contribution guidelines, code of conduct, and development practices, crucial for new contributors.

Documentation should be clear, concise, and accessible to both technical and non-technical users. Avoid jargon and explain complex concepts in simple terms.
Documentation should be kept up-to-date with the latest changes in the project. Outdated documentation can be misleading and frustrating for users and contributors.

[jdwilkin4]

I think this is another good article for open source documentation
https://www.cmsdrupal.com/blog/anatomy-great-open-source-documentation-how-document-your-projects-github

As for API documentation, I think covering tools like swagger would be a good option
https://swagger.io/

For the developer documentation, maybe we could focus more on contribution guidelines and development practice because I feel like the other points you mentioned were covered in the setup section.

Thoughts? 😃

[BekahHW]

As for API documentation, I think covering tools like swagger would be a good option swagger.io

For the developer documentation, maybe we could focus more on contribution guidelines and development practice because I feel like the other points you mentioned were covered in the setup section.

Thoughts? 😃

Totally agree. The more we write, the more I see overlap in different sections.

[adiati98]

Is Developer Documentation the same with Community Documentation? Something like what we have in VC handbook and resources?