Help:CreateNewPage: Difference between revisions

From Calidus HUB
m (Minor formatting change)
(Updated)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
You must be logged in to be able to create new pages in Assist. When you are, shortcuts to create new pages will appear below here.
{{Note}} You must be logged in to be able to create new pages in Assist.
 
When you are, shortcuts to create new pages will appear below here.
 


<div style="display:none;" class="apt-user-show">
<div style="display:none;" class="apt-user-show">


Choose your document titles well - these will be included in the printed/output PDF documents on the top of every page, and therefore should be very descriptive - examples are provided of the standards being followed
{{Note}} Choose your document titles well - these will be included in the printed/output PDF documents on the top of every page, and therefore should be very descriptive - examples are provided of the standards being followed.
 
Similarly, the Products chosen when creating the new page should be used from the list below. This is because the Assist system automatically categorises all pages into sub-categories by Product based on your entry. Choosing the right one means that this is automatic and will be most useful to those using the system.
* CTMS
* EPOD
* MCS
* ASSIST
* TCM
* VEhub
* Vision
* WCS
* PORTAL
* WMS
* Bay Diary
* TOC
 


== New Pages ==
== New Pages ==
Line 34: Line 52:


== Patches/Release Notes ==
== Patches/Release Notes ==
Release notes are broadly in different formats, but all release notes will be categorised automatically for you.
A guide to creating ERs is available here: [[Creating an ER]]. Although this is specific to the ER process, the guide is mostly applicable to all other release documents as well.
=== WMS or TMS Patch ===
=== WMS or TMS Patch ===
* CTMS e.g. PATCH C-TMS P091
* CTMS e.g. PATCH C-TMS P091
Line 59: Line 82:


=== WCS Patch ===
=== WCS Patch ===
* Generic - UP{Date}_{Client} e.g. UP20250709
* Generic - UP{DateYYMMDD}_{Client} e.g. UP250709
* Client Specific - UP{Date}_{Client} e.g.  UP20250709_CER
* Client Specific - UP{DateYYMMDD}_{Client} e.g.  UP250709_CER


<inputbox>
<inputbox>
Line 91: Line 114:
placeholder=Enter EPOD Admin/Server Relnote
placeholder=Enter EPOD Admin/Server Relnote
</inputbox>
</inputbox>
=== Portal Release Note ===
* REL Sys Version Client-Optional
* e.g. REL Portal 2.03.01
* e.g. REL Portal 11.03.01 CTY
<inputbox>
type=create
buttonlabel=Create New Portal Release Note
preload=Template:Portal_RelNote
break=yes
placeholder=Enter Relnote
</inputbox>
=== General Release Note ===
* REL Sys Version Client-Optional
* e.g. REL MCS 2.03.01
* e.g. REL Portal 11.03.01 CTY
<inputbox>
type=create
buttonlabel=Create New General Release Note
preload=Template:General_RelNote
break=yes
placeholder=Enter Relnote
</inputbox>


== Specific Document Types ==
== Specific Document Types ==
Line 105: Line 155:


=== Estimate ===
=== Estimate ===
* EST 123456 Client - DocName
* EST 123456 (ClientRef) Client - DocName


<inputbox>
<inputbox>
type=create
type=create
buttonlabel=Create New EST
buttonlabel=Create New EST
preload=Template:EST
preload=Template:Estimate_Template
break=yes
break=yes
placeholder=Enter EST title
placeholder=Enter EST title

Latest revision as of 15:26, 8 August 2025

Note Note: You must be logged in to be able to create new pages in Assist.

When you are, shortcuts to create new pages will appear below here.


Patches/Release Notes

Release notes are broadly in different formats, but all release notes will be categorised automatically for you.

A guide to creating ERs is available here: Creating an ER. Although this is specific to the ER process, the guide is mostly applicable to all other release documents as well.


WMS or TMS Patch

  • CTMS e.g. PATCH C-TMS P091
  • WMS e.g. PATCH WMS P091

WMS or CTMS Emergency Release

  • CTMS e.g. ER C-TMS 047-001
  • WMS e.g. ER WMS 046-001

WCS Patch

  • Generic - UP{DateYYMMDD}_{Client} e.g. UP250709
  • Client Specific - UP{DateYYMMDD}_{Client} e.g. UP250709_CER

EPOD Device/APK Release Note

  • e.g. Calidus ePOD Android v4.5 APK 4.05.01.20

EPOD Admin/Server Release Note

  • e.g. Calidus ePOD Server 4.5.1.12

Portal Release Note

  • REL Sys Version Client-Optional
  • e.g. REL Portal 2.03.01
  • e.g. REL Portal 11.03.01 CTY

General Release Note

  • REL Sys Version Client-Optional
  • e.g. REL MCS 2.03.01
  • e.g. REL Portal 11.03.01 CTY


Specific Document Types

Functional Specification

  • FS 123456 Client - DocName

Estimate

  • EST 123456 (ClientRef) Client - DocName

Solution Design

  • SDD 123456 Client Solution Design

Small Change Request

  • SCR 123456 - DocName

Category Utility Pages

These are used when creating a title page and appendix page to group loads of categorised pages into a single combined book.

Document Title Page

  • {DocName} Title e.g. similar to the Document titles above
    • UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Title
    • Area - Description Guide e.g. Orders - Order Guide Title

Document Appendix Page

  • {DocName} Appendix e.g. similar to the Document titles above
    • UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Appendix
    • Area - Description Guide e.g. Orders - Order Guide Appendix