# Plugin Documentation Style Guide

**URL:** https://meta.discourse.org/t/plugin-documentation-style-guide/95973
**Category:** Feature
**Created:** [August 30, 2018, 5:05am UTC](https://meta.discourse.org/t/plugin-documentation-style-guide/95973 "2018-08-30T05:05:51Z")
**Posts on this page:** 1
**Showing post:** 8

<div class="post-metadata">

### Author: ![jomaxro](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/jomaxro/32/126216_2.png) [@jomaxro](https://meta.discourse.org/u/jomaxro)
#### Post date: [November 9, 2018, 3:22am UTC](https://meta.discourse.org/t/plugin-documentation-style-guide/95973/8 "2018-11-09T03:22:43Z")

</div>

Part 7 of the Plugin guide is now up:

> [@Developing Discourse Plugins - Part 7 - Publish your plugin](https://meta.discourse.org/t/beginner-s-guide-to-creating-discourse-plugins-part-7-publish-your-plugin/101636):
>
> Previous tutorial: [Developing Discourse Plugins - Part 6 - Add acceptance tests](https://meta.discourse.org/t/developing-discourse-plugins-part-6-add-acceptance-tests/32619) You’ve [created your plugin](https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-1/30515), you’ve [uploaded it to GitHub](https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-4-git-setup/31272) and you’ve [added tests](https://meta.discourse.org/t/beginner-s-guide-to-creating-discourse-plugins-part-6-acceptance-tests/32619). Great! Problem is, no one else knows about it. Documenting your plugin All plugins require good documentation. Users need to know what the plugin does, how to install it, important settings/configuration changes needed, and how to use it. Plugins should be documented in two different locations: the README.md file within your git repo,…

---

_[View the full topic](https://meta.discourse.org/t/plugin-documentation-style-guide/95973)._