Style guide

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search

This is the Style Guide for developing documentation on this site for PHENOM Portal.

Graphics

When including a screenshot or graphic for an article:

  1. Reuse an existing graphic. You can search the existing graphics here.
  2. If the existing graphic is out of date, upload a new version of the graphic.
  3. If you are uploading a new graphic, specify a description using the following pattern: phenom-[area_of_phenom]-[brief-description-of-what-image-is-showing].[png|jpg]
  4. The upload will require a Description so please include a reasonable explanation.
  5. For Thumbnail, choose 'none'
  6. For Frame, choose 'frame' or select 'none' and add 'border' to the the file block [[File:xxx|border]] to have a small border around the image
  7. If the screenshot is too big, resize it by providing the width in px: [[File:xxx|600px]]


Confluence pages status

Page Added to Wiki Needs more work Updated to new UI Comments
FAQ No No No
Data Model Governance No No No
About Proprietary Data No No No
Considerations for Data Model Governance No No No
Data Sharing, Protection & Partitioning No No No
Getting Started Yes No N/A
How-To Articles Yes No Yes
Login Yes No N/A
Dashboard Yes Yes No
Release Notes No No No
Search Bar Yes Yes No
Settings Yes Yes Yes
Account Partially No No
Subscription No No No
Navigate Yes No Yes Renamed to Data Modeling
Nav Tree Partially No Yes
Moving Elements No No No
Searching & Filtering No No No
Tagging No No No
Meridian Map No No No
Diagram No No No
Details (Model Review and Editing) Yes No N/A
Constraints Yes No Yes
Entities and Associations Yes No Yes
Entity Attributes Yes No Yes Only described Attribute Move so content moved to Entities and Associations
Measurements Yes No Yes
Measurement Systems & Coordinate Systems Yes No Yes
Messages N/A No No It's not possible to create Messagea anymore
Observables Yes No Yes
Packages Yes No Yes
Platform Type/Enumeration editing No No No
Reference Point No No No
Semantic Matches No No No
Services / UOPs & Message Ports No No No
Transport Channel No No No
View Attributes No No No
Views No No No
View Trace No No No
Integration Model Editor No No No
[Old] Scratchpad N/A No No Obsolete page
[Old] Diagrams N/A No No Obsolete page
Generate Yes No Yes
Templates - Creating and Editing Syntax Yes No Yes
Model & Artifact Generation Yes No Yes
Health Check No No No Moved to Data Modeling
Impact Assessment No No No Moved to Data Modeling
Analytics Yes No No Missing Attribute usage - Moved to Data Modeling
Entity Usage No No No Moved to Data Modeling
Semantic Equivalencies Partially No No Moved to Data Modeling
Manage Yes No Yes
Model Structure & Sub-Structure in Phenom Portal Yes Yes Partially Renamed to Projects and Models Management
Creating a Filtered Project Yes No Yes
Branch (Branch Management and Content Versioning / Merging) Yes Yes No Renamed to Push, Pull, and Approve
Change Sets Yes Yes Partially Need to update health check screenshot for new UI
Import No No No Goes in Data Modeling
DSDM Import No No No
Enum-Literal Import No No No
FACE XMI v2.1 Import No No No
View-Characteristic Import No No No
Migrate N/A No No Obsolete page
Advanced Topics N/A No No Empty section
Tutorials Yes No N/A
Exercise: Developing an Entity Model Yes Yes Yes
Exercise: Document Interfaces using Phenom Portal Yes Yes Yes
PHENOM Tutorial Series Yes No Partially