Scrittura tecnica

Questo capitolo si concentra sulla proposta – il tipo di documento che fa approvare o assumere te o la tua organizzazione per fare un progetto.

In un corso di scrittura tecnica, il compito della proposta è un’opportunità per te di presentare un’idea a un pubblico specifico e nominato su un’idea che hai per migliorare un certo aspetto di quella società, organizzazione, centro o altro business. Qualunque sia l’argomento scelto, devi essere in grado di condurre una ricerca accademica approfondita che integrerai nella tua relazione finale.

Per iniziare a pianificare una proposta, ricorda la definizione di base: una proposta è un’offerta o un’offerta per completare un progetto per qualcuno. Le proposte possono contenere altri elementi – background tecnico, raccomandazioni, risultati di indagini, informazioni sulla fattibilità e così via. Ma ciò che rende una proposta una proposta è che chiede al pubblico di approvare, finanziare o concedere il permesso di fare il progetto proposto.

Una proposta dovrebbe contenere informazioni che consentano al pubblico di quella proposta di decidere se approvare il progetto, approvare o assumervi per fare il lavoro, o entrambi. Per scrivere una proposta di successo, mettiti al posto del tuo pubblico – il destinatario della proposta – e pensa a quale tipo di informazioni questa persona avrebbe bisogno per sentirsi sicura di farti completare il progetto.

È facile confondersi sulle proposte, o almeno sul tipo di proposta che scriverai per questo corso. Immaginate di avere un’idea fantastica per l’installazione di una nuova tecnologia dove lavorate, e di scrivere un documento che spieghi come funziona, mostrando i benefici, e poi esortando la direzione ad installarla. È una proposta? Da solo, questo non sarebbe una proposta completa. Sarebbe più simile a un rapporto di fattibilità, che studia i meriti di un progetto e poi raccomanda a favore o contro. Tuttavia, tutto ciò che servirebbe per rendere questo documento una proposta sarebbe aggiungere elementi che chiedono l’approvazione della direzione per andare avanti con il progetto. Inoltre, per questa classe, uno di questi elementi è la ricerca scientifica. Certamente, alcuni scrittori di proposte devono vendere i progetti che propongono, ma in tutti i casi, le proposte devono vendere lo scrittore (o l’organizzazione dello scrittore) come colui che deve completare il progetto.

Tipi di proposte

Considera le situazioni in cui si verificano le proposte. Un’azienda può inviare un annuncio pubblico richiedendo proposte per un progetto specifico. Questo annuncio pubblico, chiamato richiesta di proposte (RFP), potrebbe essere pubblicato attraverso siti web, e-mail, social media, giornali o riviste specializzate. Le aziende o gli individui interessati al progetto scriverebbero delle proposte in cui riassumono le loro qualifiche, i programmi e i costi del progetto, e discutono il loro approccio al progetto. Il destinatario di tutte queste proposte le valuterebbe, selezionerebbe il miglior candidato, e poi elaborerebbe un contratto.

Ma le proposte vengono anche in modo molto meno formale. Immaginate di essere interessati a fare un progetto al lavoro (per esempio, indagare i meriti dell’introduzione di una nuova tecnologia per aumentare la produttività). Immaginate di aver incontrato il vostro supervisore e di aver cercato di convincerlo di questo. Lei potrebbe rispondere dicendo: “Scrivimi una proposta e la presenterò alla direzione superiore”. Questo è più simile al tipo di proposta che scriverai in un corso di scrittura tecnica.

La maggior parte delle proposte può essere divisa in diverse categorie:

• Interno, esterno: Una proposta a qualcuno all’interno della tua organizzazione (un’azienda, un’agenzia governativa, ecc.) è una proposta interna. Con le proposte interne, potresti non dover includere alcune sezioni (come le qualifiche) o molte informazioni in esse. Una proposta esterna è una proposta scritta da un’organizzazione separata e indipendente o da un individuo a un’altra entità simile. L’esempio tipico è il consulente indipendente che propone di fare un progetto per un’altra azienda. È probabile che tu scriva uno di questi due tipi di proposte per questa classe, e può essere sollecitato o non sollecitato, come spiegato di seguito.
• Sollecitato, non sollecitato: Una proposta sollecitata è quella in cui il destinatario ha richiesto la proposta. In genere, un’azienda invia richieste di proposte (RFP) per posta o le pubblica in qualche fonte di notizie. Ma le proposte possono essere sollecitate ad un livello molto locale: per esempio, potresti spiegare al tuo capo che grande cosa sarebbe installare una nuova tecnologia in ufficio; il tuo capo potrebbe essere interessato e chiederti di scrivere una proposta che offra di fare uno studio formale dell’idea. Le proposte non richieste sono quelle in cui il destinatario non ha richiesto proposte. Con le proposte non richieste, a volte devi convincere il destinatario che esiste un problema o un bisogno prima di poter iniziare la parte principale della proposta. La maggior parte dei progetti di scrittura tecnica che abbiamo visto in questa classe sono state proposte non richieste.

Scenari tipici per la proposta

Molti di voi potrebbero non aver mai pensato molto a produrre una relazione tecnica basata su una proposta fattibile. Diversi esempi di argomenti sono inclusi nel foglio di assegnazione; ecco alcune idee aggiuntive:

• Immaginate che un’azienda abbia un problema o voglia fare qualche tipo di miglioramento. L’azienda invia una richiesta di proposte; voi ne ricevete una e rispondete con una proposta. Ti offri di entrare, investigare, intervistare, fare raccomandazioni e presentare il tutto sotto forma di un rapporto.
• Un’organizzazione vuole un seminario sulla tua esperienza. Tu scrivi una proposta per tenere il seminario – incluso nel pacchetto è una guida o un manuale che le persone che partecipano al seminario riceveranno.
• Un’agenzia ha appena iniziato a usare un nuovo sistema di dati online, ma il manuale dell’utente è tecnicamente complesso e difficile da leggere. Tu ricevi una richiesta di proposte da questa agenzia per scrivere una guida semplificata o una guida di avvio.
• Immagina che un’organizzazione no-profit focalizzata su un particolare problema voglia un consulente per scrivere un manuale o una guida per i suoi membri. Questo documento presenterà le informazioni sul problema in un modo che i membri possano capire.

Non tutti gli argomenti di ricerca sono appropriati per la scrittura tecnica. Gli argomenti che sono basati su valori e credenze non rientrano nella categoria dei tecnici. Gli argomenti storici e letterari non si qualificano. Controlla sempre con il tuo istruttore qualsiasi idea di argomento che hai prima di iniziare il tuo progetto.

Inoltre, tieni presente che devi integrare la ricerca accademica nella tua relazione finale, scegli un argomento per il quale puoi trovare facilmente tale materiale. Mentre le interviste e altre fonti di prima mano sono spesso preziose per una relazione, una che si basa pesantemente su queste fonti non soddisferà i risultati di questo corso.

Sezioni comuni nelle proposte

Il seguente fornisce una rassegna delle sezioni che troverete comunemente nelle proposte, presentate in questa classe in formato memo. Non siate certi che ognuna di esse debba essere presente nella proposta che scriverete, né che debbano essere nell’ordine in cui sono presentate qui. Fai riferimento al foglio di assegnazione e considera altri tipi di informazioni uniche per il tuo argomento che dovrebbero essere incluse nella tua particolare proposta.

Quando leggi questo capitolo sulle proposte, controlla l’esempio di memo sulla proposta condiviso nella cartella della nostra unità della settimana corrente. Ancora una volta, tieni presente che non tutte le sezioni discusse qui saranno presenti negli esempi, ma la maggior parte sì.

Introduzione. Pianifica l’introduzione alla tua proposta con attenzione. Assicurati che faccia tutte le seguenti cose (ma non necessariamente in quest’ordine) che si applicano alla tua particolare proposta:

• Indica che il contenuto del memo è una proposta per un progetto specifico.
• Sviluppa almeno una breve dichiarazione motivante che incoraggi il destinatario a continuare a leggere e a considerare l’approvazione del progetto (specialmente se si tratta di una proposta non richiesta o competitiva).
• Fai una panoramica dei contenuti della proposta.

Individua il problema, l’opportunità o la situazione. Spesso si verifica subito dopo l’introduzione, la sezione del background discute cosa ha portato alla necessità del progetto – quale problema, quale opportunità esiste per migliorare le cose, qual è la situazione di base. Per esempio, la gestione di una catena di centri diurni può aver bisogno di assicurarsi che tutti i dipendenti conoscano la RCP a causa dei nuovi mandati statali che la richiedono, o un proprietario di un terreno di pino nell’Oregon orientale può volere che il terreno produca legname vendibile senza distruggere l’ambiente.

Anche se il pubblico nominato della proposta può conoscere molto bene il problema, scrivere la sezione di background è utile per dimostrare la vostra particolare visione del problema. Inoltre, se la proposta non è richiesta, una sezione di background è quasi un requisito – probabilmente dovrai convincere il pubblico che il problema o l’opportunità esiste e che dovrebbe essere affrontato.

Benefici e fattibilità del progetto proposto. La maggior parte delle proposte discute brevemente i vantaggi o i benefici del completamento del progetto proposto. Questo agisce come un tipo di argomento a favore dell’approvazione del progetto. Inoltre, alcune proposte discutono la probabilità di successo del progetto. In una proposta non richiesta, questa sezione è particolarmente importante – stai cercando di “vendere” al pubblico il progetto.

Descrizione del lavoro proposto (risultati del progetto). La maggior parte delle proposte deve descrivere il prodotto finito del progetto proposto. In un corso di scrittura tecnica, questo significa descrivere il documento scritto che si propone di scrivere, il suo pubblico e il suo scopo; fornire uno schema; e discutere cose come la lunghezza, la grafica, la rilegatura e così via. Nello scenario che definisci, ci possono essere altri lavori come condurre seminari di formazione o fornire un servizio continuo. In questa fase iniziale, potresti non sapere tutto ciò che servirà per completare il tuo progetto, ma dovresti almeno avere un’idea di alcuni dei passi richiesti.

Metodo, procedura, teoria. In alcune proposte, avrete bisogno di spiegare come andrete a completare il lavoro proposto. Questo agisce come un ulteriore elemento persuasivo; mostra al pubblico che avete un approccio solido e ponderato al progetto. Inoltre, serve a dimostrare che hai la conoscenza del campo per completare il progetto.

Schedule. La maggior parte delle proposte contiene una sezione che mostra non solo la data di completamento prevista, ma anche le pietre miliari chiave del progetto. Se state facendo un grande progetto che si estende su molti mesi, la linea temporale mostrerà anche le date in cui consegnerete i rapporti sui progressi. Se non puoi citare date specifiche, cita la quantità di tempo per ogni fase del progetto.

Costi, risorse richieste. La maggior parte delle proposte contiene anche una sezione che dettaglia i costi del progetto, sia interno che esterno. Con i progetti esterni, potresti aver bisogno di elencare le tue tariffe orarie, le ore previste, i costi delle attrezzature e delle forniture, e così via, e poi calcolare il costo totale del progetto completo. I progetti interni, naturalmente, non sono gratuiti, quindi dovresti comunque elencare i costi del progetto: le ore necessarie per completare il progetto, le attrezzature e le forniture che userai, l’assistenza di altre persone nell’organizzazione, e così via.

Conclusioni. Il paragrafo o la sezione finale della proposta dovrebbe riportare i lettori a concentrarsi sugli aspetti positivi del progetto. Nella sezione finale, potete esortarli a contattarvi per definire i dettagli del progetto, ricordare loro i vantaggi di fare il progetto, e forse fare un’ultima argomentazione per voi o per la vostra organizzazione come la scelta giusta per il progetto.

Sezioni speciali specifiche del progetto. Ricordate che le sezioni precedenti sono tipiche o comuni nelle proposte scritte, non requisiti assoluti. Chiedetevi sempre di cos’altro potrebbe aver bisogno il vostro pubblico per capire il progetto, la necessità di esso, i benefici che ne derivano, il vostro ruolo in esso, e le vostre qualifiche per farlo. Cos’altro hanno bisogno di vedere per approvare il progetto e approvare voi per farlo?

Requisiti speciali per l’incarico

A seconda della situazione di scrittura, la vostra proposta potrebbe dover includere anche altri elementi specializzati. Alcuni di questi sono descritti di seguito. Nota: alcuni di questi elementi saranno effettivamente richiesti nel tuo memo di progresso per questo corso; tuttavia, in una reale situazione di scrittura tecnica, il tuo supervisore potrebbe chiederti di includere nella tua proposta uno dei seguenti elementi:

Pubblico: Descrivi il pubblico del rapporto finale (che potrebbe essere diverso dal pubblico della proposta). Potresti aver bisogno di discutere per chi è progettato il rapporto, i loro titoli e lavori, il loro background tecnico e la loro capacità di capire il rapporto.

Fonti di informazione: Elenca le fonti di informazione; assicurati che ci siano informazioni adeguate per il tuo argomento; elenca le citazioni per specifici libri, articoli, opere di riferimento, altri tipi di fonti che pensi possano contribuire alla tua relazione.

Grafica: Elenca i grafici di cui pensi che la tua relazione avrà bisogno in base al loro tipo e al loro contenuto. (Se non riesci a pensare a nessun elemento di cui la tua relazione avrebbe bisogno, potresti non avere un buon argomento – fai un po’ di brainstorming con il tuo istruttore). Per questa classe, ti sarà richiesto di creare e includere grafici nella tua relazione finale.

Outline: Includi uno schema degli argomenti e dei sottoargomenti che pensi di trattare nella tua relazione.

Proposte e pubblico

Ricorda che, in un corso di scrittura tecnica, il compito di proposta ha diversi scopi: (1) ti dà un po’ di esperienza nello scrivere una proposta; (2) ti fa iniziare a pianificare la tua relazione di fine corso; (3) dà al tuo istruttore la possibilità di lavorare con te sul tuo progetto, per essere sicuro che tu abbia un argomento valido. Per la seconda e la terza ragione, devi includere elementi specifici nella tua proposta (come annotato nel tuo foglio di assegnazione) alcuni dei quali potrebbero non sembrare appropriati in una proposta del mondo reale.

In questo corso di scrittura tecnica, la proposta è l’inizio di un processo di ricerca e scrittura lungo settimane che passa attraverso molte fasi fino ad arrivare al punto finale: la relazione tecnica. Si presenta la proposta solo una volta durante questo processo. Dopo di che, scriverai e presenterai diversi tipi di documenti: una relazione di avanzamento, una bozza, una bibliografia commentata, una bozza grafica, una bozza di relazione e una relazione finale. Fai attenzione a usare il termine “proposta” solo se ti riferisci specificamente alla fase iniziale del tuo progetto.

Un altro punto da tenere a mente riguarda il pubblico delle proposte rispetto al pubblico dei rapporti che vengono dopo nel processo di scrittura. Il pubblico della tua proposta è la persona che può approvare, sostenere ed eventualmente finanziare la tua ricerca e la tua scrittura. Il rapporto finale che producete può essere diretto a un pubblico diverso. Si consideri l’esempio di una proposta scritta a un supervisore di una società di energia solare che suggerisce la creazione di un manuale di politica per gli installatori di pannelli solari residenziali. Il pubblico della proposta potrebbe essere un dirigente, la cui conoscenza degli aspetti tecnici potrebbe essere molto ampia. D’altra parte, il pubblico del rapporto finale è costituito dai tecnici, che possono avere una conoscenza più specializzata di quella del dirigente. Il contenuto e il linguaggio usati per questi due diversi tipi di pubblico dovranno essere adattati alla situazione di scrittura. (Per saperne di più, rivedete il capitolo sull’analisi del pubblico.)

Lista di controllo per la revisione delle proposte

Nel rivedere e rivedere la vostra proposta, tenete presente quanto segue:

• Utilizzate il formato giusto. Ricorda, per questa classe, stai scrivendo questa proposta in formato memo.
• Scrivi un chiaro riassunto (o introduzione) all’argomento della tua proposta.
• Identifica esattamente cosa stai proponendo di fare.
• Assicurati che un rapporto – un documento scritto – sia in qualche modo coinvolto nel progetto che stai proponendo di fare. Ricorda che in questo corso di scrittura tecnica ci stiamo esercitando a scrivere una proposta come quelle fatte nel mondo reale e a completare un progetto di ricerca a livello universitario.
• Assicurati che le sezioni della tua proposta siano in un ordine logico e naturale e che tu usi correttamente i sottotitoli e i punti elenco (e qualsiasi altro stile di formattazione).
• Indirigi la proposta al tuo pubblico designato, non al tuo istruttore.

Informazioni sull’attribuzione del capitolo