https://github.com/automattic/document-feedback

Close the loop — Get feedback from readers on the documentation you write.
https://github.com/automattic/document-feedback

wordpress wordpress-plugin wpvip-plugin

Last synced: 4 months ago
JSON representation

Close the loop — Get feedback from readers on the documentation you write.

• Host: GitHub
• URL: https://github.com/automattic/document-feedback
• Owner: Automattic
• Created: 2011-12-16T19:29:01.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2023-08-27T16:12:41.000Z (over 1 year ago)
• Last Synced: 2024-10-07T11:17:41.148Z (4 months ago)
• Topics: wordpress, wordpress-plugin, wpvip-plugin
• Language: PHP
• Homepage: https://wordpress.org/plugins/document-feedback/
• Size: 201 KB
• Stars: 42
• Watchers: 119
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
[![Run PHPUnit and PHPCS](https://github.com/Automattic/Document-Feedback/actions/workflows/integrate.yml/badge.svg)](https://github.com/Automattic/Document-Feedback/actions/workflows/integrate.yml)

# Document Feedback

Close the loop — get feedback from readers on the documentation you write.

Document Feedback appends a simple feedback form to Pages (or other post types that you specify). Readers are asked whether the document answered their question or not.

If the reader indicates "Yes", they'll be asked about which details were useful to them. If the reader indicates "No", they'll be prompted to respond with which details they hoped to see.

Feedback is emailed to the post author, and summarized in a post meta box in the admin.

If you'd like to check out the code and contribute, [join us on GitHub](https://github.com/Automattic/Document-Feedback). Pull requests are more than welcome!

## Installation

Here's the low-down on how you can get up and running:

1. Upload the `document-feedback` folder to your plugins directory (e.g. `/wp-content/plugins/`).

2. Activate the plugin through the 'Plugins' menu in WordPress.

3. Document feedback functionality is automatically appended to Pages by default.

4. (Optionally) Modify the prompt text using a filter.

## Screenshots

A feedback prompt is automatically appended to every Page. These prompts can be modified with a filter.  

![A feedback prompt is automatically appended to every Page. These prompts can be modified with a filter.](screenshot-1.png)  

If a user submits feedback, they'll be asked to clarify their feedback. These responses are emailed to the post author.  

![If a user submits feedback, they'll be asked to clarify their feedback. These responses are emailed to the post author.](screenshot-2.png)  

All feedback is summarized in a post meta box on the Page edit screen.  

![All feedback is summarized in a post meta box on the Page edit screen.](screenshot-3.png)  

## Frequently Asked Questions

There aren't any frequently asked questions yet. Why not [ask one in the forums](http://wordpress.org/support/plugin/document-feedback)?

## Changelog

### 1.3 (Feb. 18, 2013)

* New Simplified Chinese localization. Thanks [sparanoid](https://github.com/sparanoid)

### 1.2 (Jan. 29, 2013)

* New Bulgarian localization. Thanks [mpeshev](https://github.com/mpeshev)

* New Italian localization. Thanks [milesimarco](https://github.com/milesimarco)

### 1.1 (Jan. 8, 2013)

* New Turkish localization. Thanks [mustafauysal](https://github.com/mustafauysal).

### 1.0 (Dec. 27, 2012)

* Initial release