Create a packaging technical file

Template article

Internal notes

• Please use this template and follow the guidelines for writing platform instructions. Delete the guidelines and the example text, and add your own text.
• You don’t have to start from scratch — make use of the existing resources. 
• Keep the aligned topic name.
• All chapters are required unless you find that they are not applicable / useful in specific cases. Our aim is to keep the structure of the articles as consistent as possible.  
• Screenshots should be taken from demo accounts, have a minimalist style, and contain no sensitive information. (Screenshot Guidelines for Manuals and Documentation)
• Ensure the latest updates from IT, Sales, or Regulatory Knowledge are taken into account.

 

(max 30–50 words, no heading)

Start with a clear explanation of what the feature does, why it’s useful, and when someone would use it.

 

Example:

Add your company logo to personalize the ProductIP platform. This helps your team feel at home and ensures that stakeholders instantly recognize your brand in shared documents and interfaces. Ideal for organizations that want to align the platform with their corporate identity or differentiate between business units.

 

Feature access (max 20–30 words)

Indicate which roles or permissions are required, and which subscription plans (Essential, Advanced, Professional, or Enterprise) include the feature.

 

Example:
 Only users with the Administrator role can upload or change the company logo. 

 

This feature is available for Essential / Advanced / Professional / Enterprise customers. Contact sales@productip.com to gain access to additional features.

 

This feature is available to all ProductIP users.

This feature is available for all plans.

 

Before you begin (max 20–30 words)

List prerequisites or technical requirements.

 

Example:

Accepted formats: PNG, JPG, or SVG

Maximum file size: 1MB

Recommended dimensions: 300 x 100 pixels

 

Video instructions (max 20–30 words)

Prefer to watch instead? We’ve created a short walkthrough video.

No video available? Use: A short step-by-step guide will follow soon! 

 

Example:

Watch the full video guide here: YouTube or Youku

 

(for internal reference only) Link Youtube to all existing video’s: https://www.youtube.com/playlist?list=PLrtuRXZ0EQ3bmGgWx88o1kdDq3TEoXx6l

 

Steps (no strict word limit)

Provide clear, numbered steps. Type tab and button text in bold.

Include screenshots where needed. When steps are explained in text, there is no need for visual support of the steps. 

 

Example:

1. Go to Settings > Company Profile
2. Click Upload Logo
3. Select your logo file from your computer
4. Click Save
5. Refresh the page to see your changes

 

Tips and best practices (max 40–60 words)

Offer helpful suggestions or common dos and don’ts.

 

Example:

• Use a transparent background for a cleaner look
• Avoid large or overly detailed logos
• Keep the file name short and clear (e.g., logo-companyname.png)

 

Troubleshooting (max 60–80 words)

Describe common problems and how to resolve them.

 

Example:

• Logo not displaying? 

Refresh the page or clear your browser cache.

 

• Upload fails? 

Check the file format or reduce the file size.

 

Still having issues? Contact ProductIP via helpdesk@productip.com. 

 

FAQ (each Q&A: max 30–50 words)

Answer common questions related to the feature.

 

Example:

Not yet. Currently, each workspace supports one logo at a time.

 

Related articles (max 20–30 words)

Link to other helpful or connected content. 

Mention the article in your text but add the active link under ‘Related articles’ only. 

 

Use:

(See Related articles)

 

List all related articles using the correct link. Do not list articles that are not yet finished. They will be added when ready.

 

Example:

• Managing user roles
• Customizing shared documents
• Setting up your company profile

 

 

General

Layout

• Arial
• Sub headline 18 pt bold
• Text 14 pt
• Text on buttons and tabs: bold
• Steps: numbering
• Tips & troubleshooting, FAQ and Related articles: use squares, type question in Italic, add answer below question.

 

Wording

Use the exact terms as present in Platform text, buttons and tabs. If you find a term should be adjusted in the Platform, please discuss.

 

• Document request (not invite)
• Select/clear the checkbox (not tick or check)
• Technical file (not file or file request)
• Under the tab (not in/on the tab)