brandfy-guia-pdf

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Compilar o guia da marca em PDF

将品牌指南编译为PDF

Protocolo operacional

操作流程

  • Plano e progresso: planejar fonte, tema, compilação e inspeção.
  • Fontes de verdade: ler
    BRAND.md
    ,
    brand/README.md
    como índice, os ativos vinculados e pdf-build.md.
  • Escopo e idempotência: copiar o design system para
    brand/pdf/
    e gerar o PDF sem modificar a fonte editável nem substituir personalizações.
  • Validação: recompilar, conferir links, páginas, imagens, fontes, sumário e metadados.
  • Resumo final: informar fonte, PDF, ferramentas usadas e avisos.
  • 规划与进度: 规划来源、主题、编译和检查。
  • 可信来源: 阅读
    BRAND.md
    brand/README.md
    作为索引,以及关联资产和pdf-build.md
  • 范围与幂等性: 将设计系统复制到
    brand/pdf/
    并生成PDF,不修改可编辑源文件也不替换自定义内容。
  • 验证: 重新编译,检查链接、页面、图片、字体、目录和元数据。
  • 最终总结: 记录来源、PDF、使用的工具和注意事项。

Fluxo

流程

  1. Confirmar que
    BRAND.md
    é a versão aprovada e que os links relativos existem.
  2. Instalar ou conferir os ativos locais:
    bash
    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --install-assets
    O comando copia CSS, template, Inter, Manrope e licenças para
    brand/pdf/
    . Arquivos existentes são preservados. Use
    --force-assets
    somente depois de revisar as diferenças da versão instalada.
  3. Compilar:
    bash
    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --input BRAND.md \
      --output brand/brand-guide.pdf \
      --brand-name "Nome da marca"
  4. O compilador usa Pandoc para gerar HTML semântico e WeasyPrint para produzir o PDF. Instalar essas ferramentas quando a verificação inicial apontar ausência.
  5. Preservar o contrato
    pdf-design-system: 1.0.0
    : A4, capa clara, Manrope, Inter, sumário, componentes editoriais e paginação. Nome, logo, descrição, tagline e cor de link podem ser personalizados sem duplicar o tema.
  6. Abrir o PDF e conferir capa, sumário, quebras, tabelas, SVGs, PNGs, URLs, cabeçalhos, rodapés e propriedades do documento.
  7. Recompilar sempre que o Markdown, o CSS, uma fonte ou um ativo vinculado mudar.
Quando uma imagem, uma tabela ou um texto aparecer errado no PDF, corrija
brand/README.md
, o CSS ou o ativo vinculado. Recompile e abra a página afetada para confirmar o ajuste sem editar o PDF diretamente.
  1. 确认
    BRAND.md
    为已批准版本,且所有相对链接均存在。
  2. 安装或检查本地资产:
    bash
    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --install-assets
    该命令会将CSS、模板、Inter字体、Manrope字体和许可证复制到
    brand/pdf/
    。现有文件将被保留。仅在检查过安装版本的差异后,才可使用
    --force-assets
    参数。
  3. 编译:
    bash
    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --input BRAND.md \
      --output brand/brand-guide.pdf \
      --brand-name "Nome da marca"
  4. 编译器使用Pandoc生成语义化HTML,并使用WeasyPrint生成PDF。当初始检查提示缺失时,请安装这些工具。
  5. 遵循
    pdf-design-system: 1.0.0
    规范:A4尺寸、简洁封面、Manrope字体、Inter字体、目录、编辑组件和分页。品牌名称、标志、描述、标语和链接颜色可自定义,无需复制主题文件。
  6. 打开PDF并检查封面、目录、分页、表格、SVG、PNG、URL、页眉、页脚和文档属性。
  7. 每当Markdown、CSS、字体或关联资产发生变更时,重新编译。
当PDF中的图片、表格或文本显示错误时,请修改
brand/README.md
、CSS或关联资产。重新编译并打开受影响的页面以确认调整,请勿直接编辑PDF文件。

Raciocínio do especialista

专家思路

Tratar o PDF como uma representação da fonte canônica, não como documento independente. Avaliar legibilidade, navegação, sequência pedagógica, reprodução, acessibilidade e rastreabilidade dos ativos. Uma compilação sem erro técnico ainda falha quando oculta exemplos, separa regra do contexto ou torna tabelas ilegíveis.
将PDF视为权威来源的呈现形式,而非独立文档。评估可读性、导航性、教学逻辑、可复制性、可访问性以及资产的可追溯性。即使编译过程无技术错误,若隐藏示例、脱离上下文呈现规则或导致表格不可读,仍视为失败。