Modelo de Instrução: Design de Documentação Técnica e Arquitetura de Conteúdo Estruturado

[digressão]

No artigo anterior, alguns amigos relataram que o tamanho da fonte de [Jian Rui Siqi] era muito pequeno e era um pouco difícil de ler.

Em primeiro lugar, gostaria de agradecer a este leitor entusiasmado por compartilhar abertamente seus sentimentos comigo e por dar opiniões valiosas para me ajudar a melhorar.

Portanto, neste artigo, tentei aumentar o tamanho da fonte em 1 ponto. Vamos ver se você tem mais alguma dúvida, sinta-se à vontade para me perguntar a qualquer momento.

【Mais perto da história】

Recentemente, entrei para uma organização "misteriosa" chamada [O Grande Engenheiro de Comando]. Aqui, concordamos com o valor das instruções no AIGC, seja instruindo o ChatGPT a produzir texto ou instruindo o Midjourney a produzir imagens, a bênção do Prompt é indispensável.

Como Robin Li disse em seu discurso "Grandes modelos estão prestes a mudar o mundo": A interação humano-computador em linguagem natural provocará uma revolução nas palavras imediatas. No futuro, 50% do trabalho mundial será de engenharia de palavras imediatas; fazer perguntas é mais importante do que resolvê-las.

Portanto, tentaremos produzir modelos de instrução que possam ser reutilizados, para que mais pessoas possam começar facilmente e usar ferramentas AIGC para resolver problemas em cenários típicos.

Mapa temático de Midjourney. Aviso: Arquitetura de conteúdo estruturado --ar 16:9 --s 750 --niji 5

【Fundo】

Os engenheiros de P&D geralmente aparecem quando participam do desenvolvimento de documentos: eles não sabem como começar; eles não sabem qual conteúdo escrever; a estrutura lógica do conteúdo de saída não é clara. O principal problema é que não há um design razoável do esboço do conteúdo do documento antes que o documento seja desenvolvido.

Para resolver este problema de "dificuldade persistente" que assola o P&D, podemos tentar orientar o ChatGPT a produzir o esboço do conteúdo por meio de instruções, como referência, e fazer as modificações necessárias em combinação com cenários reais, de modo a ajudar os engenheiros de P&D a documentar melhor escrita.

【Lógica de comando】

A função: Engenheiro de documentação técnica
Antecedentes: Esclarecer os recursos que os engenheiros de documentação técnica devem ter, para que seja fácil para o ChatGPT entender.
Tarefas: projetar documentos especificados; esquema de conteúdo de saída
Exigir:
- explicitamente orientado a objetos
- Esclarecer os objetivos da informação
- Esclareça o conteúdo principal
- regras claras de escrita

【Exemplo de comando】

Se você for um engenheiro de documentos técnicos sênior, crie uma nota de desenvolvimento para o código-fonte aberto do exemplo de aplicativo e forneça o resumo do conteúdo do documento.

Histórico: Um engenheiro de documentação técnica é um profissional que escreve, edita, organiza e mantém a documentação técnica de um produto. Sua principal responsabilidade é traduzir informações técnicas complexas em documentos fáceis de entender e usar para ajudar os usuários e outras partes interessadas a entender e usar melhor o produto. Os engenheiros de documentação técnica precisam ter boas habilidades técnicas e de redação, ser capazes de usar habilmente várias ferramentas e software para criar e gerenciar documentos e escrever diferentes tipos de documentos de acordo com diferentes públicos e cenários, como manuais do usuário, guias de instalação , guia de solução de problemas, etc. Eles também precisam trabalhar em estreita colaboração com a equipe de desenvolvimento de produtos e outros departamentos relevantes para garantir que a documentação seja mantida em sincronia com o desenvolvimento e as atualizações do produto.

Exigir:

Orientado a objetos: engenheiro de desenvolvimento de aplicativos; parceiro
Objetivos da informação:
- Ajude os leitores a obter, compilar e executar o código-fonte aberto;
- Guiar os leitores a entender a lógica de negócios e os princípios de programação com base em códigos de exemplo de aplicativo;
- Instrua os leitores a desenvolver programas aplicativos em combinação com cenários reais.
conteúdo principal:
- Aplicação de codec de imagem de produtos de computação AI
- Os principais módulos do sistema incluem desenvolvimento front-end, desenvolvimento back-end e desenvolvimento de negócios
- Concentre-se em explicar a lógica de negócios e os princípios de implementação do código;
- Não há necessidade de expandir o método de chamada da interface de programação.
Normas de redação:
- De acordo com o princípio da pirâmide;
- Contém 2~3 níveis de diretórios;
- A hierarquia é:
  - Títulos de nível 1: 1, 2, 3
  - Títulos secundários: 1.1, 1.2, 1.3
  - Títulos de nível 3: 1.1.1, 1.1.2, 1.1.3
  - e assim por diante
- Complemente o conteúdo do documento com base nas informações existentes tanto quanto possível; ou dê dicas de redação.

【Saída do ChatGPT】

O seguinte é gerado pelo GPT-3.5:

Esquema da Documentação de Desenvolvimento

prefácio

- Declare o propósito, escopo e público-alvo do documento

- Glossário e explicação das abreviaturas

Capítulo 1 Visão geral

1.1 Introdução do produto

- Antecedentes, objetivos e cenários de aplicação do produto

- As principais funções e características do produto

- Arquitetura do produto e seleção de tecnologia

1.2 Módulos do sistema

- Módulo de desenvolvimento front-end

- Módulo de desenvolvimento de back-end

- Módulo de Desenvolvimento de Negócios

1.3 Estrutura do código

- Organização de código e estrutura de diretórios

- O arquivo principal do código e a introdução da função da classe

- Dependências de código e divisão de módulos

Capítulo 2: Preparação do ambiente

2.1 Ambiente de desenvolvimento

- Seleção de sistema operacional e ferramentas de desenvolvimento

- Instalação e configuração de bibliotecas e frameworks dependentes

- Preparação do ambiente de desenvolvimento e habilidades de depuração

2.2 Ambiente operacional

- Configuração de hardware e requisitos do sistema operacional

- Instalação e configuração do ambiente operacional

- Monitoramento e otimização do ambiente operacional

Capítulo 3: Implementação de código

3.1 Desenvolvimento front-end

- Escolha da pilha e estrutura de tecnologia de front-end

- Criação e desenvolvimento de front-end

- Implementação de componentes e módulos front-end

3.2 Desenvolvimento de back-end

- Escolha da pilha e estrutura de tecnologia de back-end

- Implementação de serviços de back-end e APIs

- Implementação de módulos e componentes de back-end

3.3 Desenvolvimento de Negócios

- Análise de necessidades e processos de negócios

- Projeto de lógica de negócios e modelo de dados

- Realização de módulos e funções de negócios

Capítulo 4: Implantação de aplicativos

4.1 Método de implantação

- Metas de implantação e requisitos ambientais

- O método e o processo de implantação

- Detecção e otimização de implantação

4.2 Gestão de operação e manutenção

- Introdução às tarefas e ferramentas de O&M

- Desenho de estratégia e processo de operação e manutenção

- Habilidades de monitoramento e solução de problemas de O&M

Capítulo 5: Exemplos de Aplicações

5.1 Cenários de aplicação

- Descrição de cenários de aplicação e requisitos de negócios

- Análise de cenários de aplicação e processos de negócios

- Desenho de cenários de aplicação e modelos de negócios

5.2 Implementação do Aplicativo

- Implementação de requisitos e funções de aplicativos

- Implementação de lógica de aplicação e modelo de dados

- Implementação da interface e interação do aplicativo

Capítulo 6: Referências

6.1 Referências

- Introdução das principais referências e links

- Citação e interpretação de referências

6.2 Perguntas Frequentes

- Resumo de problemas e soluções comuns

- Estudos de caso de problemas e soluções comuns

6.3 Comunidade de desenvolvedores

- Uma introdução à comunidade de desenvolvedores e recursos

- Interação e compartilhamento de comunidades e recursos de desenvolvedores

Prompt：Modelo de escrita de prompt AI --ar 16:9 --s 750 --niji 5

【sessão interativa】

Se você foi paciente o suficiente para ver isso, pode gastar um pouco mais de tempo e participar do feedback:

Você entende qual problema específico esse modelo de instrução resolve?
Você acha que este modelo de comando pode ajudá-lo a escrever uma documentação melhor?

Mande-me uma mensagem, diga-me o que você pensa, junte-se à discussão.

Finalmente, você está convidado a se juntar a mim para aprender a escrever comandos AI e liberar a produtividade das ferramentas AIGC.

Modelo de Instrução: Design de Documentação Técnica e Arquitetura de Conteúdo Estruturado | Prática AIGC

Acho que você gosta