Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione...

44
Argo CMS Come gestire i contenuti e realizzare manuali e documentazione tecnica

description

Argo CMS è il software di KEA dedicato alla gestione collaborativa dei contenuti e alla realizzazione automatica di documentazione tecnica e di prodotto multicanale: manuali, help online, schede (schede tecniche, schede offerta), cataloghi, listini, e-commerce... La guida "Argo CMS Get Started" illustra come partire con un progetto di Argo: - Installazione e configurazione - Recupero della documentazione pregressa - Gestione del flusso di editing e revisione - Gestione del flusso di traduzione - Configurazione automatica della documentazione tecnica (manuali, help online, schede, ecc.): gestione delle parti comuni; marcatura (tagging; anche da distinta base [BOM - Bill of Material]); specifica delle condizioni di riuso; configurazione della documentazione - Output multicanale. Contattateci per una demo gratuita di Argo CMS: http://www.keanet.it/contatti.htm

Transcript of Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione...

Page 1: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Argo CMS Come gestire i contenuti e realizzare manuali e documentazione tecnica

Page 2: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Installazione & Configurazione

Page 3: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Installazione

Collegare il database di Argo a MS SQLServer

Installare i client di Argo Collegare i client al database di Argo

(Impostazioni Database) Inserire il codice di aggiornamento di Argo

(Impostazioni LiveUpdate) Attivare i Plugin di Argo

(C:\Programmi\Argo 2.0\Plugin)

1/3

Page 4: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Configurazione

Creare e attivare le lingue (Amministrazione Lingue)

Gestire ruoli, permessi e utenti (Amministrazione Utenti)

Personalizzare l’interfaccia di Argo (Look&Feel Preferenze | Skin)

2/3

Page 5: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Configurazione

Impostare gli stili (Modelli Stili)

Impostare i destinatari (Modelli Destinatari)

Impostare i bookmark (Modelli Bookmark)

3/3

Page 6: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Recupero della documentazione

pregressa

Page 7: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Selezione dei contenuti

Selezionare i contenuti da importare in Argo Criteri per la selezione:

Standardizzazione Univocità Segmentazione

Criteri validi per i contenuti in tutte le lingue Lingua madre Traduzioni

Page 8: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Criteri per la selezione

Standardizzazione Se la documentazione pregressa contiene

più versioni dello stesso contenuto Selezionare o creare 1 sola versione da considerare standard

1/3

Page 9: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Criteri per la selezione

Univocità Se un contenuto è comune a più manuali o

è presente in più punti dello stesso manuale Selezionare e importare in Argo il contenuto 1 sola volta

2/3

Page 10: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Criteri per la selezione

Segmentazione Segmentare i contenuti in base a

logiche di riuso Bottom-up

Per esempio in base alle esigenze di riuso del contenuto … e/o… Top-down

Per esempio in base a standard ANSI Z535, S1000D, DITA, ecc.

3/3

Page 11: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Documenti da importare

Realizzare uno o più documenti con i contenuti da importare in Argo Realizzare un documento per ogni lingua

Salvare o esportare il documento in formato .rtf, .doc o .docx

Page 12: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Importazione dei documenti

Lingua madre Creare e classificare in Argo uno o più

documenti in cui importare i contenuti (Home Apri Gestione documenti)

Importare in Argo i file .rtf, .doc o .docx con i contenuti selezionati (Importa Docx Rtf)

1/2

Page 13: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Importazione dei documenti

Traduzioni Utilizzare le funzioni di

esportazione e importazione per importare i contenuti tradotti (Esporta Office) (Importa Office)

2/2

Page 14: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Editing

Page 15: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Strutturazione dei contenuti

Obiettivi della classificazione e segmentazione dei contenuti Ottimizzare il

Flusso di redazione e revisione Flusso di traduzione Reperimento di contenuti esistenti Riuso dei contenuti

Page 16: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Editing

Utilizzare gli strumenti di editing di Argo per Ottimizzare contenuti recuperati dalla

documentazione pregressa Inserire nuovi contenuti

Page 17: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Funzioni di editing

Principali funzioni di editing di Argo Editing rapido di immagini, tabelle e warning

Immagini nel flusso di testo Stili Riferimenti incrociati Variabili Riclassificazione rapida dei contenuti Modelli di contenuti Ricerca di contenuti esistenti

Page 18: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Immagini, tabelle e warning

Immagini Inserimento rapido con drag&drop Gestione di immagini nel testo e in tabella

Tabelle Inserimento rapido dei dati con copia&incolla

da fonti dati tabulate Definizione della larghezza delle colonne

Warning Collegamento a ogni tipo di warning

di un pittogramma predefinito

1/7

Page 19: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Stili

Stili Associazione di uno stile a ogni contenuto

Lo stile Definisce la funzione logica del contenuto Determina la resa grafica del contenuto sull’output

Forzature dello stile Possibilità di inserire grassetti, corsivi, ecc.

2/7

Page 20: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Riferimenti incrociati

Riferimenti incrociati a Testi

Capitoli, sottocapitoli, paragrafi, ecc. Immagini

I riferimenti incrociati sono risolti in automatico sull’output

3/7

Page 21: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Variabili

Variabili Gestione di variabili multilingua nel testo

Esempi di variabili Ragione sociale, denominazione del brand Denominazione di famiglie, modelli, prodotti Codici matricola Espressioni del glossario aziendale …

4/7

Page 22: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Riclassificazione dei contenuti

Riclassificazione dei contenuti con drag&drop

5/7

Page 23: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Modelli di contenuti

Definizione e uso di modelli Permettono di gestire strutture di

contenuti ricorrenti in base a logiche Bottom-up

Per esempio schede di ricambi, prodotti, offerte, ecc. … e/o… Top-down

Per esempio warning, ecc.

6/7

Page 24: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Ricerca di contenuti

Ricercare contenuti esistenti usando La classificazione dei contenuti Il motore di ricerca

Globale (Documenti Trova) Cerca in tutti i documenti di Argo

Interno a un documento Cerca nel documento

7/7

Page 25: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Gestione del flusso di lavoro

Bookmark Permettono di

Definire lo stato di un contenuto Per esempio «da completare», «da rivedere»,

«approvato», ecc. Cercare contenuti in base allo stato Esportare contenuti in base allo stato Evidenziare lo stato dei contenuti sulle bozze Modificare lo stato dei contenuti

Page 26: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Revisioni & Varianti

Page 27: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Revisioni

Creare la revisione di un documento (Documenti Duplica)

Creare la revisione o la variante di un contenuto Duplicare

L’elemento di classificazione del contenuto … oppure … Il contenuto stesso

Page 28: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Traduzioni

Page 29: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Gestione del flusso di traduzioni

Flag di traduzione E’ attivabile a mano o in automatico

(Documento Lingua Imposta flag di traduzione) Permette di

Contrassegnare Cercare Esportare Evidenziare sulle bozze

i contenuti da tradurre Modificare lo stato dei contenuti da tradurre

Page 30: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Attività preliminari

Prima di iniziare a tradurre Allineare in automatico le tabelle

nella lingua da tradurre Se necessario, copiare i contenuti da una

lingua di riferimento a quella da tradurre (Esporta Traduzioni)

Page 31: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Tradurre in Argo

Selezionare la lingua da tradurre (Documento Lingua Menu a tendina)

Selezionare l’opzione Mostra lingua di riferimento

Eseguire la traduzione Modificare lo stato del

Flag di traduzione

Page 32: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Tradurre con software esterni

Esportare selettivamente i contenuti da tradurre (Esporta Office) I contenuti esportati da Argo

possono essere tradotti utilizzando Strumenti di MS Office CAT Tool

1/2

Page 33: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Tradurre con software esterni

Importare in automatico i contenuti tradotti (Importa Office) Se necessario, modificare lo stato

del Bookmark e/o del Flag di traduzione

2/2

Page 34: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Configurazione automatica

di un documento

Page 35: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Principi di funzionamento

Argo permette di Gestire contenuti comuni a livello di

Capitolo, paragrafo e segmento di contenuto Marcare i contenuti comuni

Attributi e valori definiscono le condizioni di riuso Applicare condizioni di riuso selettive Configurare in automatico la documentazione

(Documenti Wizard)

Page 36: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Contenuti comuni

Definire uno o più documenti come Globale (Documenti Apri Gestione documenti)

Segmentare i contenuti in base a logiche di riuso Bottom-up

Per esempio in base alle esigenze di riuso del contenuto … e/o… Top-down

Per esempio in base a standard ANSI Z535, S1000D, DITA, ecc.

Page 37: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Marcatura

Definire attributi e valori (Modelli Proprietà)

Esempi di tipi di proprietà Famiglie e modelli Codici della distinta Mercati Canali e tipi di pubblicazione

Marcare con Proprietà

Gli elementi di classificazione dei contenuti Destinatari

I segmenti di contenuto

Page 38: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Condizioni di riuso

Specificare le condizioni di riuso Creare un file .txt in cui inserire le Proprietà

in base a cui configurare il documento Può trattarsi di un file

Creato a mano Esportato dall’ERP, PDM, configuratore

in uso presso l’azienda Per esempio nel caso di distinte

Page 39: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Configurazione automatica

Argo configura in modo automatico il documento di destinazione, riprendendo i contenuti da uno o più documenti comuni in base alle condizioni di riuso specificate e alle marcature presenti (Documenti Wizard) Il riuso può essere

By reference Mantiene il collegamento fra originale e contenuto riusato

By content Crea una copia scollegata dall’originale

Page 40: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Documento configurato

Sul documento configurato E’ possibile riclassificare

contenuti riusati by reference e by content Non è possibile modificare

contenuti riusati by reference Le modifiche vanno effettuate sull’originale

E’ possibile modificare contenuti riusati by content

E’ possibile inserire nuovi elementi di classificazione e contenuti

Page 41: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Output

Page 42: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Output

Argo permette di realizzare in automatico output in MS Word

(Esporta Word) Adobe InDesign o FrameMaker

(Esporta FrameEditor) HTML

(Plugin HTML) MS Excel

(Esporta Office) XML

(Web Esporta in XML)

Page 43: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

Stili e resa grafica

In Argo contenuto e presentazione sono distinti Sull’output la resa grafica degli stili

è determinata da: Modello di MS Word Template di Adobe InDesign o FrameMaker Foglio di stile CSS dell’HTML

Modelli, template e CSS sono modificabili liberamente

Page 44: Argo CMS: Get Started! - Guida rapida a come realizzare manuali, help online e documentazione tecnica con il software Argo CMS

I nostri riferimenti

Kea s.r.l. Via Strà, 102 37042 Caldiero (VR) Italia

Tel. e Fax: +39 045 6152381 E-mail: [email protected] Web: www.keanet.it Blog: http://blog.keanet.it/