Help Center

The in-app Help Center (? icon / sidebar Help Center) is built from the Markdown files in docs/help-articles/. This page explains how it works and lists every article.

How it works

Source: each article is a Markdown file with front matter: title, category, slug, context (comma-separated screen keys), optional roles (restricts visibility), sort, summary, related.
Loading: the installer seeds all articles. Help Center → Manage articles → Load articles from docs adds new files and refreshes articles that have not been edited in-app (revision 1); edited articles are never overwritten.
Context-sensitive help: every screen passes a help key; the ? button opens help?ctx=<key>, which shows the matching articles.
Search: full-text search over titles, summaries and bodies, filtered by the reader's role.
Editing: users with help.configure can create, edit, unpublish and reorder articles; Markdown from docs/help-articles/ is converted to HTML on load; edited content is sanitized on save and again at render time; every save keeps the previous revision (history visible in the editor) and is audited.
Without login: the standalone documentation in docs/ is served read-only at /manual for people who cannot sign in.

Article index (51 articles)

Getting Started

Article	Screen keys	Audience	Summary
What is Q-Putaway?	`dashboard`	All	Overview of the warehouse management system, its modules and the inventory principles it follows.
Requirements and installation	`installation`	super_admin	Server requirements and the web installer steps.
First login and the dashboard	`dashboard`	All	Signing in, the setup checklist and reading the dashboard.
Company and warehouse setup	`warehouse-setup`	All	Create warehouses, understand system locations and choose the working warehouse.
Users, roles and permissions	`users-roles`	super_admin,admin	Default roles, custom roles, warehouse access and safety rules.
Using the Help Center	`help-center`	All	Search help, open help for the current screen, and print articles.

Master Data

Article	Screen keys	Audience	Summary
Products, barcodes and batch settings	`product-master`, `master-data`	All	Create products, barcodes, packaging levels, shelf life and tracking options.
Units of measure and conversions	`units-conversions`	All	How base units, packaging levels and conversion factors work.
Locations and bins	`locations-bins`	All	Warehouse → zone → aisle → rack → shelf → bin hierarchy, bin generation, capacity and pick sequence.
Suppliers, customers, transporters and reason codes	`suppliers-customers`	All	Other master data used by receipts, orders, dispatch and adjustments.
CSV templates and bulk import	`csv-import`	All	Download templates, validate with a dry run, fix errors and commit.

Warehouse Operations

Article	Screen keys	Audience	Summary
Goods receipt (GRN)	`goods-receipt`	All	Receive deliveries with scanning, batch/expiry capture, damaged and rejected quantities.
Quality inspection	`quality-control`	All	Release quarantined stock or reject it to damaged.
Putaway tasks and bin suggestions	`putaway`	All	How putaway tasks are created, suggested, assigned and completed.
Complete a putaway task on mobile	`putaway-mobile`, `worker-tasks`	All	Step-by-step scan-to-confirm putaway on a phone or tablet.
My Tasks (worker screen)	`worker-tasks`	All	The simplified task list for warehouse workers.
Outbound orders and FEFO allocation	`orders`	All	Create, confirm, allocate, de-allocate and cancel customer orders.
Picking (order, batch, wave and zone)	`picking`	All	Create pick lists and pick with scan verification on mobile.
Packing and packing slips	`packing`	All	Pack picked goods into cartons and print packing slips and carton labels.
Dispatch and delivery notes	`dispatch`	All	Ship picked stock to customers, with vehicle, driver and documents.
Customer and supplier returns	`returns`	All	Authorize, receive, inspect and restock customer returns; ship supplier returns.
Bin and warehouse transfers	`transfers`	All	Move stock between bins immediately, or between warehouses with approval and in-transit tracking.
Stock counts (cycle, full, blind)	`stock-counts`	All	Count stock with scanning, recount large variances and post approved adjustments.
Stock adjustments and status changes	`adjustments`	All	Correct stock with reason codes, evidence and second-person approval; hold, release or mark damaged.
Replenishment and reorder suggestions	`replenishment`	All	Keep picking faces filled from reserve stock, and see what to reorder.

Barcode Scanning

Article	Screen keys	Audience	Summary
USB and Bluetooth barcode scanners	`mobile-scanning`	All	Use keyboard-wedge scanners with any scan box in Q-Putaway.
Mobile camera scanning	`mobile-scanning`	All	Scan barcodes and QR codes with a phone or tablet camera.
Camera permissions	`mobile-scanning`	All	Allow or re-enable camera access in Chrome, Safari and Edge.
GS1 labels, batches and bins	`mobile-scanning`, `goods-receipt`	All	Scan GS1-128/DataMatrix carton labels and bin labels.
Printing labels	`labels-printing`	All	Print product, batch, bin, carton, pallet, receipt and dispatch labels, and set up label printers.

Mobile and PWA

Article	Screen keys	Audience	Summary
Install Q-Putaway as an app (Android, iPhone, desktop)	`mobile-pwa`	All	Add Q-Putaway to the home screen or desktop as an installable web app.
Mobile navigation and offline limitations	`mobile-pwa`	All	Using Q-Putaway on phones and what works without a connection.
Safe application updates	`mobile-pwa`, `application-updates`	All	How the app tells you about a new version without losing your work.

Inventory and Expiry

Article	Screen keys	Audience	Summary
Stock balances and the movement ledger	`inventory-stock`, `ledger`	All	How stock is recorded, the stock states and how they affect availability.
FEFO and FIFO allocation	`orders`, `batch-expiry`	All	How Q-Putaway chooses which batch to pick.
Batch tracking, near-expiry and expired stock	`batch-expiry`	All	Batch details, expiry alerts, blocking/recall and authorised date corrections.
Batch traceability and product recall	`batch-expiry`	All	Find where a batch came from, where it is and which customers received it.
Reconciliation, counts and adjustments	`ledger`, `stock-counts`, `adjustments`	All	Verify balances against the ledger and correct physical differences.

Reports and Analytics

Article	Screen keys	Audience	Summary
Running and exporting reports	`reports`	All	Find a report, filter it, export to CSV or Excel, print or save as PDF, and save filters.
Demand forecasting and reorder suggestions	`forecasting`	All	How forecasts, days of stock, reorder points and stock-out/expiry risk are calculated.
Email settings and scheduled reports	`email-settings`	super_admin,admin	Configure SMTP, send a test email, and have reports emailed automatically.

Administration

Article	Screen keys	Audience	Summary
Administration overview (users, settings, audit)	`settings`, `audit-log`	super_admin,admin	Manage users, roles, settings, custom fields and the audit log.
Backups and restore	`backup-restore`	super_admin	Create, download, verify and restore encrypted backups safely.
Application updates (server)	`application-updates`	super_admin	Install signed update packages with automatic backup and rollback.
Editing Help Center articles	`help-admin`	super_admin	Create, edit, publish and revise articles; context links.
Your profile, password, 2FA and devices	`profile-security`	All	Change your password, enable two-factor authentication and manage remembered devices.

Troubleshooting

Article	Screen keys	Audience	Summary
Login and password problems	–	All	Locked accounts, forgotten passwords, 2FA codes and sessions that end.
Scanner and camera problems	–	All	Unreadable barcodes, duplicate scans, wrong characters and camera failures.
CSV import errors	–	All	Fixing common validation errors in bulk imports.
Data not refreshing, database, email and permission problems	–	All	Common operational issues and what to check.
PWA and update problems	–	All	Install option missing, old version showing, offline page.