Level 6 · In practice

6.4Toolkit

Goal: have checklists, templates and scripts ready to use for the key moments of a WinDev project.

Estimated time: 10 min · If you only have 5 min: read “The essentials in 30s” + the diagram.

The essentials in 30 seconds

Before: a starting checklist prevents forgetting the analysis, the links and the permissions.
During: code and incident-sheet templates save time and keep a record.
After: a delivery and backup checklist protects both the customer and the developer.

Yacine's thread — the everyday toolkit

Yacine ended up gathering his reference points in a small toolkit: a checklist before starting, an incident-sheet template, a delivery checklist and a few reusable code snippets. Nothing spectacular, but everything that saves him from reinventing the wheel on every project.

A toolkit is only worth something if it is used: four applied reference points are better than twenty forgotten ones.

Why a toolkit

The same questions come back on every project: is the analysis ready? are the controls linked? are the queries bounded? are the permissions tested? A checklist avoids depending on memory and on the mood of the day.

Reference points, not dogma

A checklist is not bureaucracy: it is a safety net. You adapt it to the project's size, remove what is not useful and keep what has already prevented an incident.

Passing it on

A shared toolkit speeds up a colleague's arrival and reduces dependence on a single person. Documenting what you do is also protecting yourself.

Before starting a project

Analysis defined (files, items, relationships, keys)?
Main needs and screens identified with the users?
Database mode chosen (Classic or Client/Server)?
Permissions and user profiles sketched out?
Backup and test environment planned?

Reference points & reflexes to reach for

Analyse before coding; link the controls rather than tinkering
Filter and bound on the database side; check the indexes
Wrap sensitive writes in transactions
Define permissions by role and check on the server side
Test-run on a clean machine before any delivery

Deliver & maintain

Backup done and restore checked?
Numbered version and delivery note written?
Dependencies included in the installer?
Automatic update tested on a clean workstation?
Incident log up to date and code tracked (SCM)?

Common misinterpretation: “A checklist is for beginners.” No. It is precisely when you master a subject that you forget an obvious point. The checklist does not replace competence: it stops it from tripping over routine.

Text version of the diagram (SEO / screen readers / translation): Before: analysis, needs, database mode, permissions, backup. During: links, bounded queries, transactions, tests. After: clean-machine test run, complete installer, numbered version, incident log. Lesson: four applied reference points are better than twenty forgotten ones.

Ready-to-say script — presenting your toolkit (30 s)

“I have four reference points: a starting checklist, an incident sheet, a delivery checklist and a few code templates. It avoids reinventing the wheel and discovering a problem at the customer's site.”

Keep this to explain your organisation to a manager or a customer.

Ready-to-say script — framing a test (30 s)

“I test on a representative copy, never directly in production: I can make a mistake without consequences, then I deliver with a backup and a planned rollback.”

Useful for reassuring about the prudence of the approach.

Copy-paste template — robust WLangage snippet

// Transactional write of an order
SI HTransactionDébut() ALORS
    HRAZ(Commandes)
    Commandes.NumCmd = pNum
    Commandes.DateCmd = DateSys()
    SI HAjoute(Commandes) = Vrai ALORS
        HTransactionValide()
    SINON
        HTransactionAnnule()
    FIN
SINON
    Erreur("Transaction failed: " + HErreurInfo())
FIN

Copy-paste template — delivery note

Version: [x.y]   Date: [..]
Content: [fixes / enhancements]
Database: migration [yes/no]
Backup: done on [date]
Clean-machine test run: OK
Points for the user to check: [...]
Rollback: version [x.y-1] available

Very small business / small budget

A one-page checklist, an incident-sheet template and two code snippets are enough to cover the essentials.

SME in Oran

Adapt the toolkit to local workstations and habits, with labels in French and short procedures.

Remote / multi-site

Add a remote testing and delivery procedure, with centralised versions and logs.

Cross-cultural

Translate the checklists and templates so that each new colleague can apply them without a spoken explanation.

Caution: Generic reminder: a test environment and a backup are not optional as soon as you touch real data. Test on a representative copy, check the restore and never deliver without a possible rollback.

48h challenge — apply it tomorrow

Build your minimal toolkit: a delivery checklist, an incident-sheet template and a reusable code snippet, then apply it to a real project.

Section exit checklist

I have checklists and templates ready to use for my WinDev projects.
I know how to test without risk and deliver with a backup and rollback.
I have done the 48h challenge or scheduled its date.

Self-assessment 1-5: do I apply my checklists or just skim them?are my templates up to date and adapted to my projects?

← Previous : Best practices & pitfalls (V3)Next : Field feedback (V3) →

Check your understanding

Which tool protects you best before an intervention in production?

💡

A toolkit is only worth something if it is used: four applied reference points are better than twenty forgotten ones.