Naming And Organizing Applications

作者 gopigment6fec49f4ce9d無授權條款22 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫2 天前更新

Execution skill. Use when naming or organizing Pigment Applications, folders, and blocks so models stay navigable, formula-safe, and consistent across teams.

AI 產生的概覽

為 Pigment 的應用程式、資料夾與區塊設定命名與資料夾慣例,讓模型保持可瀏覽且公式安全。

功能
提供 Pigment 應用程式、資料夾、區塊、維度、指標、交易清單、屬性與表格的命名規則,包括區塊的三層名稱(技術名稱、易讀名稱、顯示名稱)、可排序的數字前置詞,以及禁用字元。它定義依功能領域組織的標準資料夾結構,並提供指標類型前置詞表,例如 INPUT_、CALC_、OUTPUT_、DATA_、ASM_、MAP_、PUSH_ 與 PULL_。最後提供檢查清單,涵蓋字元、大小寫模式、資料夾歸屬、前置詞角色、顯示名稱,以及與現有慣例的一致性。
適用情境
適用於建立或整理 Pigment 應用程式及其區塊、資料夾或名稱時,或模型需要跨團隊維持一致且公式安全的命名時。應在新增區塊之前套用,並在使用者明確要求清理時使用。對於既有應用程式,應沿用既有模式,而不是強加新慣例。
執行需求
不需要指令碼或套件,僅為說明性指示。假定代理具備 Pigment 工具,例如 tool:create_folder、tool:move_blocks、tool:update_metric 與 tool:update_list。

Apply Naming and Folder Conventions Before Creating Blocks

Before adding any block, scan the target Application for existing naming patterns. Match existing style for consistency. Only introduce standard conventions on greenfield Applications or when the user explicitly requests cleanup.

Choose the Three-Tier Name for Every Block

Every block has three name layers. Set all three deliberately:

LayerPurposeWhere it appears
Technical NameSystem identifier used in formulas, APIs, and Test & DeployFormula bar, 'Block Name' references
Friendly NameDefault label shown in the UI when no Display Name is setBlock sidebar, Views, Boards
Display NameOptional localizable label (EN/FR per member language)Everywhere except formulas and uniqueness contexts

Rules:

  • Technical Name is the source of truth for formulas — keep it stable once referenced.
  • Use Display Name for end-user readability without renaming the Technical Name.
  • Dimensions appear as-is across Boards — keep Technical Names short and readable (PascalCase, no prefix).

Never Use Periods or Colons in Block or Folder Names

Periods (.) and colons (:) break formula references and autocomplete. Application names may use a period in the sortable prefix (e.g. 00. Hub) since applications are not referenced in formulas. Avoid ambiguous spaces inside names.

Name Applications with a Sortable Prefix

Use a two-digit numeric prefix plus a descriptive title so Applications sort predictably in the Workspace:

PatternExampleUse when
00. prefix00. HubCentral shared-data Application (FX, dimensions, admin)
01.–09.01. Core ReportingUse-case Applications in logical process order
ZZ_ prefixZZ_POC Revenue PlanningRetired or unused Applications kept temporarily

Application titles use PascalCase or plain descriptive names — no metric-style prefixes.

Name Folders with Numeric Prefixes for Sort Order

Pigment sorts folders numerically (1. before 10.). Top-level: N. Name. Subfolders: N.M Name.

Standard Top-Level Folder Structure

Use tool:create_folder to create folders. Place every block in an explicit folder using tool:move_blocks. Never leave blocks in "No Folder".

Organize folders by functional area, not by block type. Each folder groups all blocks (dimensions, metrics, transaction lists, tables) that belong to the same business process or domain topic.

  • 0. Settings: Configuration metrics, variables, mapping metrics, admin blocks
  • 1+ functional area folders: All blocks for a specific business domain or process step

Example for a Workforce Planning Application:

  • 0. Settings: Admin variables, calendar config, mapping metrics
  • 1. Headcount: Employee dimension, LOAD_Employee_Events, DATA_Employee_Count, CALC_FTE
  • 2. Compensation: INPUT_Salary_Grid, ASM_Raise_Rate, CALC_Total_Comp
  • 3. Recruiting: INPUT_Open_Positions, CALC_Hiring_Plan, OUTPUT_Recruiting_Budget
  • 4. Reporting: RES_PnL_Summary, [TBL] Headcount_Summary, output metrics

Adapt numbering to complexity. Functional folders follow the business process: domain-specific steps → outputs.

Block-Type Naming Rules

Dimensions -- PascalCase, No Prefix

DepartmentCostCenterGLAccountProduct

Keep names concise -- dimensions render directly on Boards and in pivot axes.

Metrics -- Snake_Case with Type Prefix

Combine an optional process prefix (Prefix A) with a utilization prefix (Prefix B), separated by underscores:

INPUT_Budget_AmountCALC_Net_RevenueDATA_Employee_CountASM_Churn_RateMAP_Country_To_RegionPUSH_WF_Staff_CostsPULL_Hub_FX_RatesOUTPUT_Total_RevenueRES_PnL_Summary

Common Metric Prefixes

PrefixMeaningBlock role
INPUT_Manual end-user inputAssumptions, requests, overrides
CALC_Intermediary calculationDerived from other blocks
OUTPUT_ / RES_Final resultEnd outputs for reporting or sharing
DATA_Aggregated transaction dataSimple transforms from transaction lists
ASM_AssumptionModel parameters and drivers
MAP_Mapping / allocationDimension or value mapping
PUSH_Shared outwardSanitized metric copy published to other Applications (see skill:sharing-data-between-applications; does not apply to shared dimension lists)
PULL_Received inwardReference to another Application's PUSH_ metric (see skill:sharing-data-between-applications; does not apply to shared dimension lists)
LOAD_(Transaction lists only)External data load target
ADM_ / SET_Admin / settingsApplication configuration
VAR_VariableApplication-level variables
FIL_FilterTable filter metrics

Add process-specific Prefix A acronyms when the Application covers multiple domains (e.g., EE_ for existing employees, REV_ for revenue).

Transaction Lists -- Snake_Case with LOAD_ Prefix

LOAD_Sales_OrdersLOAD_Employee_EventsLOAD_GL_Journal_Entries

Optionally append the source system: LOAD_Employee_HRIS.

Properties -- Snake_Case, No Block Prefix

Sort_OrderAccount_TypeIs_ActiveExternal_ID

Tables -- Snake_Case, Optional [TBL] Prefix

[TBL] Variance_Analysis[TBL] PnL_SummaryHeadcount_Summary

Validate Names Before Saving

  1. No forbidden characters: no . or : in Technical Name or folder name (Application sortable prefixes like 00. are allowed).
  2. Correct case pattern: PascalCase for dimensions; Snake_Case with prefix for metrics, transaction lists, properties, tables.
  3. Explicit folder: block is placed in a numbered folder, not "No Folder". Use tool:move_blocks.
  4. Prefix reflects role: metric prefix matches usage (input vs calc vs output vs load).
  5. Display Name set: if end users need a friendlier label, use tool:update_metric or tool:update_list to set Display Name without changing the Technical Name.
  6. Consistent with Application: if existing blocks use a different convention, follow the established pattern.

來源與署名

來源:gopigment/ai-plugins位於skills/naming-and-organizing-applications提交6fec49f

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架