Metamation Developer Notes

  • Developer Notes
  • Resource Map
  • Tools
    • Code Formatting
    • Configuring Git
    • Assignments
    • Testing with Windows Sandbox
    • Single Binary Applications
    • Self-Updating Applications
  • Flux Guidelines
    • Flux Workflow
    • Flux Development Style Guide
    • Release notes for Flux
    • SonarCloud analysis for Flux
    • Build a Flux SDK Program
  • Technical Notes
    • Machine ID Scheme
    • Translation tables
    • Creating bend machines
    • Importing bend machines
    • Importing bend tools
    • Importing bend and cell components
    • Flux-MetaCAM interface
    • Virtual drives
    • ARV fields used in tool import
    • Bend radius and K factor calculation
    • Creating fold tool .tdata file
    • RightAngle
      • Trace Gatherer
      • Testing in Controller
    • LTS (Long term support mechanism)
  • Documentation
    • Bento tool
      • Structure
      • Syntax
      • Attributes
    • Software
      • Software Requirement
      • Installation
      • Git
      • Environment Variable
      • Tools
    • Workflow
      • Roles
      • Analyze
      • Edit
      • Proofread
      • Pre-Publish
      • Publish
      • Release cycle
      • Checklist for Documenters
    • Translation
      • General process
      • Anchor points
      • BT diff generation
      • BT translate
      • BT apply changes
      • Order at Seprotec
    • Flavoring
    • Citations
Documentation
/
Workflow
/
Proofread

Proofread

The proof reading process should be as efficient as possible.

The sharepoint provides a very fast data exchange server which could be accessed from inside and outside the Trumpf network

A good way that an expert could focus on the content and not on the tools would be to send him a Git pull Request (PR) with

  1. a link to the relevant FogbugZ case

  2. the current version in the main branch \Manuals - Dokumente\VulcanBookHTML_EN

  3. the suggested changes in the \Manuals - Proofread\Vulcanbook2.case41410\ltt

    • A typical PR page is shown below:

PullRequest1

sharepoint

The reviewer could open then the final version of the HTML pages of both pages side by side and review.

Edit Pre-Publish

      Copyright © 2023 by Metamation. All rights reserved.

    Compiled by Bento