62% documentor-lite

Code Review | Documentor - Create Product Documentation

WordPress plugin Documentor - Create Product Documentation scored 62% from 54 tests.

About plugin

  • Plugin page: documentor-lite
  • Plugin version: 1.5.3
  • PHP version: 7.4.16
  • WordPress compatibility: 4.0-5.8
  • WordPress version: 5.9.2
  • First release: Mar 13, 2015
  • Latest release: Jul 27, 2021
  • Number of updates: 21
  • Update frequency: every 111.1 days
  • Top authors: internet techies (100%)

Code review

54 tests

User reviews

43 reviews

Install metrics

800+ active / 19,790 total downloads

Benchmarks

Plugin footprint 65% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | It is important to correctly install your plugin, without throwing errors or notices
Install script ran successfully

Server metrics [RAM: ▲1.05MB] [CPU: ▼314.23ms] Passed 4 tests

An overview of server-side resources used by Documentor - Create Product Documentation
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /4.51 ▲1.0059.00 ▲4.68
Dashboard /wp-admin4.46 ▲1.0539.41 ▲4.34
Posts /wp-admin/edit.php4.67 ▲1.0351.25 ▼35.83
Add New Post /wp-admin/post-new.php8.31 ▲1.3485.07 ▼1,223.51
Media Library /wp-admin/upload.php4.42 ▲1.1327.19 ▼1.92
Guide /wp-admin/admin.php?page=documentor-admin4.3528.30
Global Settings /wp-admin/admin.php?page=documentor-global-settings4.4431.18
Add New Section /wp-admin/admin.php?page=documentor-new-section4.3426.48
Go PRO /wp-admin/admin.php?page=documentor-go-pro4.4435.02

Server storage [IO: ▲2.57MB] [DB: ▲0.01MB] Passed 3 tests

Filesystem and database footprint
This plugin was installed successfully
Filesystem: 125 new files
Database: 3 new tables, 2 new options
New tables
wp_documentor_sections
wp_documentor
wp_documentor_feedback
New WordPress options
documentor_global_options
documentorlite_db_version

Browser metrics Passed 4 tests

An overview of browser requirements for Documentor - Create Product Documentation
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,950 ▲22815.57 ▼0.209.07 ▲2.782.82 ▲0.41
Dashboard /wp-admin2,942 ▲846.18 ▼0.00116.15 ▼17.42176.94 ▲13.78
Posts /wp-admin/edit.php2,707 ▲193.14 ▼0.1065.02 ▲0.20141.10 ▼8.06
Add New Post /wp-admin/post-new.php1,751 ▲4021.23 ▲0.39436.94 ▼8.17241.59 ▲44.42
Media Library /wp-admin/upload.php1,746 ▲485.57 ▲0.06124.05 ▼19.78267.14 ▲68.99
Guide /wp-admin/admin.php?page=documentor-admin1,6055.23130.70232.66
Global Settings /wp-admin/admin.php?page=documentor-global-settings1,5435.2575.52175.47
Add New Section /wp-admin/admin.php?page=documentor-new-section2,1779.33160.49296.17
Go PRO /wp-admin/admin.php?page=documentor-go-pro1,8955.3475.84239.08

Uninstaller [IO: ▲0.00MB] [DB: ▲0.01MB] 50% from 4 tests

🔸 Tests weight: 35 | The uninstall procedure must remove all plugin files and extra database tables
These items require your attention
  • Zombie tables detected upon uninstall: 3 tables
    • wp_documentor
    • wp_documentor_feedback
    • wp_documentor_sections
  • This plugin did not uninstall successfully, leaving 1 option in the database
    • documentor_global_options

Smoke tests 25% from 4 tests

Server-side errors 0% from 1 test

🔹 Test weight: 20 | A shallow check that no server-side errors were triggered
These server-side errors were triggered
    • > GET request to /wp-admin/admin.php?page=documentor-admin
    • > Warning in wp-content/plugins/documentor-lite/core/guide.php+43
    count(): Parameter must be an array or an object that implements Countable

SRP 0% from 2 tests

🔹 Tests weight: 20 | A shallow check of the single-responsibility principle; PHP files should perform no action - including output of placeholder text - and trigger no errors when accessed directly
The following issues need your attention
  • 1× PHP files output text when accessed directly:
    • > /wp-content/plugins/documentor-lite/documentor-lite.php
  • 3× GET requests to PHP files have triggered server-side errors or warnings:
    • > PHP Fatal error
      Uncaught Error: Class 'DocumentorLiteGuide' not found in wp-content/plugins/documentor-lite/core/api.php:5
    • > PHP Fatal error
      Uncaught Error: Call to undefined function apply_filters() in wp-content/plugins/documentor-lite/core/includes/compat.php:3
    • > PHP Fatal error
      Uncaught Error: Class 'DocumentorLite' not found in wp-content/plugins/documentor-lite/core/admin.php:3

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
No browser issues were found

Optimizations

Plugin configuration 93% from 29 tests

readme.txt 88% from 16 tests

It's important to format your readme.txt file correctly as it is parsed for the public listing of your plugin
Attributes that require attention:
  • Tags: Too many tags (30 tag instead of maximum 10); only the first 5 tags are used in your directory listing
  • Screenshots: Add images for these screenshots: #1 (Guide or Document on Front-end.), #2 (Guide on mobile.), #3 (Edit Document Panel.), #4 (Add Sections Form.)
The official readme.txt might help

documentor-lite/documentor-lite.php Passed 13 tests

The main PHP script in "Documentor - Create Product Documentation" version 1.5.3 is automatically included on every request by WordPress
73 characters long description:
Best plugin to create online documentation or product guide on WordPress.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is an overview of file extensions present in this plugin and a short test that no dangerous files are bundled with this plugin
There were no executable files found in this plugin27,523 lines of code in 69 files:
LanguageFilesBlank linesComment linesLines of code
CSS111,64330213,567
PHP164044745,012
SVG2002,713
JavaScript81822922,612
Sass1537361,792
LESS1537461,782
XML12044
JSON1001

PHP code Passed 2 tests

This is a short overview of cyclomatic complexity and code structure for this plugin
No cyclomatic complexity issues were detected for this plugin
Cyclomatic complexity
Average complexity per logical line of code0.32
Average class complexity72.90
▷ Minimum class complexity5.00
▷ Maximum class complexity339.00
Average method complexity6.71
▷ Minimum method complexity1.00
▷ Maximum method complexity83.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes10
▷ Abstract classes00.00%
▷ Concrete classes10100.00%
▷ Final classes00.00%
Methods126
▷ Static methods2519.84%
▷ Public methods11692.06%
▷ Protected methods00.00%
▷ Private methods107.94%
Functions14
▷ Named functions14100.00%
▷ Anonymous functions00.00%
Constants10
▷ Global constants10100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
32 compressed PNG files occupy 0.02MB
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
skins/broad/images/feedback.png0.42KB0.64KB0.00%
skins/default/images/message.png0.35KB0.45KB0.00%
skins/default/images/collapse.png0.20KB0.24KB0.00%
skins/default/images/close.png0.78KB0.90KB0.00%
core/images/sort_both.png1.11KB0.29KB▼ 74.12%