Pyle

Documentation To-Do ​

Purpose ​

This page is the master checklist for building the Pyle documentation set from top to bottom.

It tracks:

  • the recommended order of work
  • the planned documentation hierarchy
  • what already exists
  • what still needs to be created

Use this page as the main to-do list while the documentation system is being completed.

Working Rules ​

  • Write the technical page first when a topic needs system-level accuracy.
  • Write the end-user page only when the feature is meaningful to a non-technical Pyle user.
  • Add task guides only for workflows that are repeated often enough to justify their own page.
  • Update the documentation guidelines whenever a new failure mode is discovered.

Planned Navigation Structure ​

  • Core
    • To-Do
    • Domains
      • one overview page per top-level domain
    • Reference
      • technical node dossiers
      • technical authoring standards
    • End-User
      • end-user guides
      • end-user authoring standards
    • Task Guides
      • planned workflow pages

Phase 0: Foundation ​

  • [x] Create the domain hierarchy
  • [x] Create the node feature questionnaire
  • [x] Create the technical node documentation guideline
  • [x] Create the end-user documentation guideline
  • [x] Create example technical node pages
  • [x] Create example end-user pages
  • [x] Create the first task-guide template page

Phase 1: Domain Overview Pages ​

Create one overview page per top-level domain in this order:

  1. [x] Catalog & Merchandising
  2. [x] Pricing & Promotions
  3. [x] Customer Management
  4. [x] Inventory & Vendor Supply
  5. [x] Fulfillment & Shipping
  6. [x] Order Lifecycle
  7. [x] Payments & Billing
  8. [x] Tax & Territory
  9. [x] Supporting Platform Capabilities

Phase 2: Per-Domain Execution Flow ​

This flow is complete for the first-pass top-level domain set.

For each domain, complete the same sequence:

  • [x] Confirm the domain scope against the domain hierarchy
  • [x] Confirm the leaf nodes that belong in that domain
  • [x] Write the domain overview page
  • [x] Write the priority technical node pages
  • [x] Write the priority end-user concept pages
  • [x] Write the priority end-user task guides
  • [x] Cross-link the domain page, technical pages, and end-user pages
  • [x] Review whether the documentation guidelines need to be updated

Phase 3: Cross-Domain Troubleshooting ​

This is the active second-pass track after the first-pass domain inventory.

  • [x] Confirm that the next high-value gap is operator recovery rather than more concept pages
  • [x] Add task guide: How to troubleshoot a failed ERP sync
  • [x] Add task guide: How to troubleshoot a failed import
  • [x] Add task guide: How to troubleshoot a payment that did not settle an order
  • [x] Add task guide: How to troubleshoot why a promotion is not applying
  • [x] Add task guide: How to troubleshoot why a shipping service is not available
  • [x] Add task guide: How to troubleshoot why a product is missing from the storefront
  • [x] Expand troubleshooting coverage for shipping eligibility issues
  • [x] Review whether any troubleshooting guides should also exist as domain-linked checklists
  • [x] Cross-link troubleshooting guides back into the most relevant domain and end-user pages

Checklist decision for this pass:

  • [x] Add quick checklist: Product Storefront Visibility
  • [x] Add quick checklist: Promotion Application
  • [x] Add quick checklist: Shipping Service Eligibility
  • [x] Keep ERP sync, import, and payment recovery as full guides only because they are already short and more context-dependent

Current Example Coverage ​

Already completed as examples:

Domain Checklist: Catalog & Merchandising ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Product Core, Taxonomy, Attributes and Grouped Configurability, Folded Supporting Records
  • [x] Technical page: Product
  • [x] Technical page: Product Type
  • [x] Technical page: Product Category
  • [x] Technical page: Product Attribute
  • [x] Technical page: Product Group
  • [x] Technical page: Product Manufacturer
  • [x] Technical page: Product Collection
  • [x] End-user page: Products
  • [x] End-user page: Product Types
  • [x] End-user page: Product Categories
  • [x] End-user page: Brands
  • [x] End-user page: Collections
  • [x] End-user page: Product Groups
  • [x] Task guide: How to create and publish a product
  • [x] Task guide: How to classify a product with type, category, brand, and collection
  • [x] Task guide: How to create a category structure for storefront navigation
  • [x] Task guide: How to create a collection and add product groups
  • [x] Task guide: How to configure product groups for a collection
  • [x] Task guide: How to export catalog setup to Excel

Domain Checklist: Pricing & Promotions ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Offer Resolution, System-Generated Pricing Views, Promotions And Code Redemption, Folded Supporting Records
  • [x] Technical page: Product Offer
  • [x] Technical page: Featured Offer
  • [x] Technical page: Promotion
  • [x] Technical page: Promotion Code
  • [x] Technical page: Promotion Condition
  • [x] Technical page: Promotion Benefit
  • [x] End-user page: Promotions
  • [x] End-user page: Promotion Codes
  • [x] End-user page: Featured Offers
  • [x] Task guide: How to create a promotion
  • [x] Task guide: How to add a promotion code

Domain Checklist: Customer Management ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Customer Accounts And Relationships, Segmentation And Restrictions, Customer-Owned Records, Folded Account Team And Access Surfaces
  • [x] Technical page: Customer
  • [x] Technical page: Customer Group
  • [x] Technical page: Customer Address
  • [x] Technical page: Customer List
  • [x] Technical page: Customer Product Restriction
  • [x] End-user page: Customers
  • [x] End-user page: Customer Addresses
  • [x] End-user page: Customer Lists
  • [x] Decision: no standalone end-user Customer Groups page in this pass
  • [x] Task guide: How to create a customer
  • [x] Task guide: How to manage customer addresses
  • [x] Task guide: How to create and share a customer list

Domain Checklist: Inventory & Vendor Supply ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Inventory Network And Canonical Availability, Vendor Supply Master And Feed Staging, Vendor-To-Product Mapping And Review, Vendor Assignment Rules
  • [x] Technical page: Product Inventory Item
  • [x] Technical page: Product Inventory Location
  • [x] Technical page: Product Vendor
  • [x] Technical page: Product Vendor Catalog Item
  • [x] Technical page: Product Vendor Catalog Inventory Item
  • [x] Technical page: Product Vendor Mapping
  • [x] Technical page: Product Mapping Attempt
  • [x] Technical anchor retained: Stock History
  • [x] End-user page: Inventory Locations
  • [x] End-user page: Vendors
  • [x] End-user page: Vendor Data Feeds
  • [x] End-user page: Vendor Catalog Items
  • [x] End-user page: Vendor Mappings
  • [x] End-user page: Mapping Attempts
  • [x] End-user anchor retained: Stock History
  • [x] Decision: no standalone end-user concept page for ProductInventoryItem
  • [x] Decision: no standalone end-user concept page for ProductVendorCatalogInventoryItem
  • [x] Task guide: How to create and maintain a vendor
  • [x] Task guide: How to configure, run, and troubleshoot vendor data feeds
  • [x] Task guide: How to review vendor catalog items and resolve them
  • [x] Task guide: How to create or update an inventory location
  • [x] Task guide: How to review vendor mappings
  • [x] Task guide: How to review mapping attempts
  • [x] Task guide: How to bulk edit vendor mappings with Excel

Domain Checklist: Fulfillment & Shipping ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Shipping Configuration And Eligibility, Order Shipment Selection And Shipping Lines, Fulfillment Planning And Coordination, Fulfillment Execution, Scheduling Constraints
  • [x] Technical page: Shipping Service
  • [x] Technical page: Shipping Method
  • [x] Technical page: Shipping Zone
  • [x] Technical page: Fulfillment Request
  • [x] Technical page: Fulfillment
  • [x] Technical page: Calendar Rule
  • [x] End-user page: Shipping Services
  • [x] End-user page: Shipping Zones
  • [x] End-user page: Fulfillment Requests
  • [x] End-user page: Calendar Rules
  • [x] Decision: no standalone end-user concept page for Shipping Method in this pass
  • [x] Decision: no standalone end-user concept page for Fulfillment in this pass
  • [x] Task guide: How to export and import shipping configuration
  • [x] Task guide: How to choose a shipping service on an order
  • [x] Task guide: How to review a fulfillment request
  • [x] Task guide: How to manage shipping date calendar rules

Domain Checklist: Order Lifecycle ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Cart State And Checkout Readiness, Order Authoring And Review, Commercial Adjustments And Recovery, Return Processing, Post-Purchase Visibility And Tracking
  • [x] Technical page: Cart
  • [x] Technical page: Order
  • [x] Technical page: Order Item
  • [x] Technical page: Order Return
  • [x] Decision: fold Order Risk into Order
  • [x] End-user page: Orders
  • [x] End-user page: Returns
  • [x] End-user page: Order Tracking
  • [x] Task guide: How to review an order
  • [x] Task guide: How to process a return

Domain Checklist: Payments & Billing ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Gateway Configuration And Checkout Entry, Order Payment Capture And Reconciliation, Refunds And Balance Recovery, Billing Documents And Invoice Outputs, Customer Payment Methods
  • [x] Technical page: Payment Gateway
  • [x] Technical page: Order Payment
  • [x] Technical page: Order Refund
  • [x] Technical page: Invoice
  • [x] End-user page: Payments
  • [x] End-user page: Invoices
  • [x] End-user page: Payment Methods
  • [x] Decision: no standalone technical page for CustomerCard in this pass
  • [x] Task guide: How to review order payments
  • [x] Task guide: How to retrieve an invoice

Domain Checklist: Tax & Territory ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Tax Definitions, Derived Tax Results, Nexus And Exemption Routing, Shared Territory Model
  • [x] Technical page: Tax Rate
  • [x] Technical page: Tax Line
  • [x] Technical page: Nexus
  • [x] Technical page: Geo Region
  • [x] End-user page: Tax Rates
  • [x] End-user page: Regions
  • [x] Task guide: How to review tax setup

Domain Checklist: Supporting Platform Capabilities ​

  • [x] Domain overview page
  • [x] Confirm subdomains: Identity and Access Governance, Integration and Data Exchange, Search and Discovery Infrastructure, Activity and Collaboration History
  • [x] Technical page: User / Role / Permissions
  • [x] Technical page: ERP Bridge
  • [x] Technical page: Excel Import / Export
  • [x] Technical page: Fast Search
  • [x] Technical page: Activity Log
  • [x] End-user page: ERP Bridge
  • [x] End-user page: Excel Import / Export
  • [x] End-user page: Search
  • [x] Task guide: How to run an import
  • [x] Task guide: How to review activity logs

Domain Stub Pages ​

These pages already exist as placeholders and should be filled in as each domain begins:

Active Second-Pass Guides ​