diff --git a/Page-format-for-ERPNext-docs.md b/Page-format-for-ERPNext-docs.md index e8361b2..74a1888 100644 --- a/Page-format-for-ERPNext-docs.md +++ b/Page-format-for-ERPNext-docs.md @@ -84,7 +84,7 @@ A page would usually contain only three main sections, 1. Prerequisites 2. How t > Examples for reference: [Item](https://erpnext.com/docs/user/manual/en/stock/item), [Sales Order](https://erpnext.com/docs/user/manual/en/selling/sales-order) -#### Test Company Test User? +## Test Company Test User? **No!** Use realistic regular human names and data for your screenshots. The company name should be '**Unico Plastics Inc.**' abbreviation = 'UP'. Below is the logo. @@ -99,7 +99,7 @@ Supplier names can be as mentioned below. * Kirkland and Watkins Inc. * Awesome Plastics Inc. -#### How to take screenshots? +## How to take screenshots? Ensure your screenshots are clean and there's no cut off text. For pointing out/highlighting buttons/areas use a sharp edged red box around it with the default red color on macOS #EE0000. Preferably use markdown style for linking images, it's just simpler: `![Image caption goes here](image path goes here)`. @@ -108,17 +108,17 @@ For pointing out/highlighting buttons/areas use a sharp edged red box around it - Add informative screenshots with Sidebar, Breadcrumbs visible in it so users know how to get to that screen/section -#### Videos vs screenshots vs GIFs +## Videos vs screenshots vs GIFs - Avoid GIFs since we have no control to pause, rewind, jump ahead in the video - Add videos for demonstrating complex processes - Add clean screenshots for everything else -#### Use American English everywhere +## Use American English everywhere Use american english in docs (Customization, not Customisation) -#### Module-wise structure +## Module-wise structure The hierarchy could be Modules -> Workspaces -> Doctypes/Features, Reports, Tools, Settings