Technical Writing

Ten rozdział koncentruje się na propozycji – rodzaj dokumentu, który dostaje ty lub twoja organizacja zatwierdzone lub zatrudniony do wykonania projektu.

W kursie pisania technicznego, zadanie propozycja jest okazją do przedstawienia pomysłu do konkretnego, nazwanego publiczności o idei masz do poprawy pewnego aspektu tej firmy, organizacji, centrum, lub innego biznesu. Niezależnie od wybranego tematu, musisz być w stanie przeprowadzić gruntowne badania naukowe, które włączysz do swojego raportu końcowego.

Aby rozpocząć planowanie propozycji, pamiętaj o podstawowej definicji: propozycja to oferta lub oferta wykonania projektu dla kogoś. Propozycje mogą zawierać inne elementy – tło techniczne, zalecenia, wyniki badań, informacje o wykonalności i tak dalej. Ale to, co czyni propozycję propozycją jest to, że prosi publiczność o zatwierdzenie, sfinansowanie lub udzielenie pozwolenia na wykonanie proponowanego projektu.

Propozycja powinna zawierać informacje, które pozwolą publiczności tej propozycji zdecydować, czy zatwierdzić projekt, zatwierdzić lub zatrudnić cię do wykonania pracy, lub obu. Aby napisać udaną propozycję, postaw się na miejscu odbiorców – odbiorcy propozycji – i zastanów się, jakiego rodzaju informacji ta osoba będzie potrzebować, aby czuć się pewnie zlecając Ci wykonanie projektu.

Łatwo jest pomylić się co do propozycji, a przynajmniej co do rodzaju propozycji, które będziesz pisać na tych zajęciach. Wyobraź sobie, że masz wspaniały pomysł na zainstalowanie jakiejś nowej technologii, gdzie pracujesz, i piszesz dokument wyjaśniający, jak to działa, pokazując korzyści, a następnie wzywając kierownictwo do zainstalowania go. Czy to jest propozycja? Samo w sobie nie byłoby to kompletną propozycją. Byłby to raczej raport wykonalności, który bada zalety projektu, a następnie rekomenduje jego przyjęcie lub odrzucenie. Aby jednak dokument ten stał się propozycją, wystarczy dodać do niego elementy, które proszą kierownictwo o zgodę na realizację projektu. Dodatkowo, w przypadku tej klasy, jednym z takich elementów są badania naukowe. Z pewnością niektórzy autorzy propozycji muszą sprzedawać projekty, które proponują, ale we wszystkich przypadkach, propozycje muszą sprzedawać pisarza (lub organizację pisarza) jako tego, który ma zrealizować projekt.

Typy propozycji

Rozważmy sytuacje, w których pojawiają się propozycje. Firma może wysłać publiczne ogłoszenie z prośbą o składanie ofert na konkretny projekt. To publiczne ogłoszenie, zwane zapytaniem ofertowym (RFP), może być wydane za pośrednictwem stron internetowych, e-maili, mediów społecznościowych, gazet lub czasopism branżowych. Firmy lub osoby zainteresowane projektem pisałyby następnie propozycje, w których podsumowywałyby swoje kwalifikacje, harmonogramy i koszty projektu oraz omawiałyby swoje podejście do projektu. Odbiorca wszystkich tych propozycji następnie ocenić je, wybrać najlepszego kandydata, a następnie wypracować kontrakt.

Ale propozycje również przyjść o wiele mniej formalnie. Wyobraź sobie, że jesteś zainteresowany wykonaniem projektu w pracy (na przykład zbadaniem zalet wprowadzenia jakiejś nowej technologii w celu zwiększenia wydajności). Wyobraź sobie, że spotkałeś się ze swoją przełożoną i próbowałeś ją do tego przekonać. Może ona odpowiedzieć: „Napisz mi propozycję, a ja przedstawię ją kierownictwu wyższego szczebla”. To bardziej przypomina rodzaj propozycji, którą napiszesz na kursie pisania technicznego.

Większość propozycji można podzielić na kilka kategorii:

  • Wewnętrzne, zewnętrzne: Propozycja dla kogoś w ramach organizacji (firma, agencja rządowa, itp.) jest wewnętrzną propozycją. ) to propozycja wewnętrzna. W przypadku propozycji wewnętrznych możesz nie być zmuszony do umieszczania w nich niektórych sekcji (takich jak kwalifikacje) lub tak wielu informacji. Propozycja zewnętrzna to propozycja napisana przez odrębną, niezależną organizację lub osobę do innego podmiotu. Typowym przykładem jest niezależny konsultant proponujący wykonanie projektu dla innej firmy. Szanse są, będziesz pisać jeden z tych dwóch rodzajów propozycji dla tej klasy, i może to być zamówione lub niezamówione, jak wyjaśniono poniżej.
  • Zamówiony, niezamówiony: Propozycja zamówiona to taka, w której odbiorca poprosił o propozycję. Zazwyczaj firma wysyła zapytania ofertowe (RFP) za pośrednictwem poczty lub publikuje je w jakimś źródle wiadomości. Ale propozycje mogą być zamawiane na bardzo lokalnym poziomie: na przykład, możesz tłumaczyć swojemu szefowi, jaką wspaniałą rzeczą byłoby zainstalowanie nowej technologii w biurze; Twój szef może się zainteresować i poprosić Cię o napisanie propozycji, która oferowała przeprowadzenie formalnego badania tego pomysłu. Niezamówione propozycje to te, w których odbiorca nie prosił o propozycje. W przypadku propozycji niezamówionych, czasami musisz przekonać odbiorcę, że istnieje problem lub potrzeba, zanim będziesz mógł rozpocząć główną część propozycji. Większość projektów pisania technicznego, które widzieliśmy na tych zajęciach, to były niezamówione propozycje.

Typowe scenariusze dla propozycji

Wielu z was mogło nigdy nie zastanawiać się nad stworzeniem raportu technicznego opartego na realnej propozycji. Kilka przykładowych tematów znajduje się w arkuszu zadań; oto kilka dodatkowych pomysłów:

  • Wyobraźmy sobie, że firma ma problem lub chce wprowadzić jakieś ulepszenia. Firma wysyła zapytanie ofertowe; otrzymujesz jedną z nich i odpowiadasz propozycją. Oferujesz, że przyjdziesz, zbadasz, przeprowadzisz wywiad, przedstawisz zalecenia – i zaprezentujesz to wszystko w formie raportu.
  • Organizacja chce zorganizować seminarium na temat Twojej wiedzy. Piszesz propozycję poprowadzenia seminarium – w pakiecie jest przewodnik lub podręcznik, który otrzymają osoby uczestniczące w seminarium.
  • Agencja właśnie zaczęła używać nowego systemu danych online, ale podręcznik użytkownika jest skomplikowany technicznie i trudny do przeczytania. Otrzymujesz zapytanie ofertowe od tej agencji, aby napisać uproszczony przewodnik lub przewodnik startowy.
  • Wyobraź sobie, że organizacja non-profit skupiona na konkretnym zagadnieniu chce, aby konsultant napisał podręcznik lub przewodnik dla jej członków. Ten dokument będzie przedstawiać informacje na temat problemu w sposób, że członkowie mogą zrozumieć.

Nie wszystkie tematy badań są odpowiednie do pisania technicznego. Tematy, które są oparte na wartościach i przekonaniach nie należą do kategorii technicznych. Tematy historyczne i literackie nie kwalifikują się. Zawsze sprawdź ze swoim instruktorem o wszelkich pomysłach na temat, który masz przed rozpoczęciem projektu.

W dodatku, pamiętaj, że musisz zintegrować badania naukowe w swoim raporcie końcowym, wybierz temat, dla którego możesz łatwo znaleźć takie materiały. Podczas gdy wywiady i inne źródła z pierwszej ręki są często cenne dla raportu, taki, który opiera się w dużej mierze na tych źródłach nie spełni wyników tego kursu.

Częste sekcje w propozycjach

Poniżej znajduje się przegląd sekcji, które można często znaleźć w propozycjach, złożonych w tej klasie w formacie memo. Nie zakładaj, że każda z nich musi znaleźć się w rzeczywistej propozycji, którą napiszesz, ani że muszą one być w kolejności, w jakiej zostały tu przedstawione. Odnieś się do arkusza zadań i rozważ inne rodzaje informacji unikalnych dla twojego tematu, które powinny być zawarte w twojej konkretnej propozycji.

Podczas czytania tego rozdziału na temat propozycji, sprawdź przykładową notatkę z propozycją udostępnioną w naszym folderze jednostki w bieżącym tygodniu. Ponownie, pamiętaj, że nie wszystkie sekcje omówione tutaj pojawią się w przykładach, ale większość z nich będzie.

Wprowadzenie. Zaplanuj dokładnie wprowadzenie do swojej propozycji. Upewnij się, że zawiera on wszystkie poniższe elementy (ale niekoniecznie w tej kolejności), które odnoszą się do Twojej konkretnej propozycji:

  • Wskazanie, że treść notatki jest propozycją konkretnego projektu.
  • Opracuj co najmniej jedno krótkie stwierdzenie motywujące, które zachęci odbiorcę do czytania dalej i rozważenia zatwierdzenia projektu (zwłaszcza jeśli jest to propozycja niezamówiona lub konkurencyjna).
  • Przedstaw przegląd zawartości propozycji.

Tło problemu, możliwości lub sytuacji. Często pojawia się zaraz po wprowadzeniu, sekcja tła omawia, co spowodowało potrzebę projektu – jaki problem, jaka szansa istnieje na poprawę rzeczy, jaka jest podstawowa sytuacja. Na przykład, zarządzanie siecią ośrodków opieki dziennej może trzeba zapewnić, że wszyscy pracownicy wiedzą CPR ze względu na nowe mandaty państwowe wymagające go, lub właściciel gruntów sosnowych lasów we wschodnim Oregonie może chcieć dostać ziemi produkującej sprzedaży drewna bez niszczenia środowiska.

Chociaż nazwany publiczność wniosku może znać problem bardzo dobrze, pisanie sekcji tła jest przydatna w demonstracji swój szczególny pogląd na problem. Ponadto, jeśli wniosek jest niezamówiony, sekcja tła jest prawie wymogiem – prawdopodobnie będziesz musiał przekonać publiczność, że problem lub okazja istnieje i że należy się nim zająć.

Korzyści i wykonalność proponowanego projektu. Większość wniosków krótko omawia zalety lub korzyści płynące z realizacji proponowanego projektu. Działa to jako rodzaj argumentu na rzecz zatwierdzenia projektu. Ponadto, niektóre propozycje omawiają prawdopodobieństwo sukcesu projektu. W niezamówionej propozycji, ta sekcja jest szczególnie ważna – próbujesz „sprzedać” publiczności projekt.

Opis proponowanej pracy (wyniki projektu). Większość propozycji musi opisać gotowy produkt proponowanego projektu. W kursie pisania technicznego oznacza to opisanie dokumentu pisemnego, który proponujesz napisać, jego odbiorców i celu; dostarczenie konspektu; i omówienie takich rzeczy jak jego długość, grafika, oprawa, i tak dalej. W scenariuszu, który definiujesz, może być inna praca, taka jak prowadzenie seminariów szkoleniowych lub świadczenie stałych usług. Na tym wczesnym etapie możesz nie wiedzieć wszystkiego, co będzie potrzebne do ukończenia projektu, ale powinieneś przynajmniej mieć pomysł na niektóre z wymaganych kroków.

Metoda, procedura, teoria. W niektórych propozycjach będziesz musiał wyjaśnić, w jaki sposób zamierzasz wykonać proponowaną pracę. Działa to jako dodatkowy element perswazyjny; pokazuje publiczności, że masz solidne, przemyślane podejście do projektu. Ponadto, służy do wykazania, że masz wiedzę w tej dziedzinie, aby zakończyć projekt.

Harmonogram. Większość wniosków zawiera sekcję, która pokazuje nie tylko przewidywaną datę zakończenia, ale także kluczowe kamienie milowe dla projektu. Jeśli realizujesz duży projekt rozłożony na wiele miesięcy, na osi czasu powinny znaleźć się również daty, w których będziesz dostarczać raporty z postępu prac. Jeśli nie możesz przytoczyć konkretnych dat, przytocz ilość czasu dla każdej fazy projektu.

Koszty, wymagane zasoby. Większość wniosków zawiera również sekcję wyszczególniającą koszty projektu, czy to wewnętrznego czy zewnętrznego. Z projektów zewnętrznych, może trzeba wymienić swoje stawki godzinowe, przewidywane godziny, koszty sprzętu i materiałów, i tak dalej, a następnie obliczyć całkowity koszt całego projektu. Projekty wewnętrzne, oczywiście, nie są darmowe, więc nadal należy wymienić koszty projektu: godziny, które będą potrzebne do wykonania projektu, sprzęt i materiały eksploatacyjne, których będziesz używać, pomoc od innych osób w organizacji, i tak dalej.

Wnioski. Ostatni akapit lub sekcja propozycji powinna sprowadzić czytelników z powrotem do skupienia się na pozytywnych aspektach projektu. W ostatniej sekcji możesz zachęcić ich do skontaktowania się z Tobą w celu dopracowania szczegółów projektu, przypomnieć im o korzyściach płynących z realizacji projektu, a może przedstawić ostatni argument przemawiający za Tobą lub Twoją organizacją jako właściwym wyborem do realizacji projektu.

Szczególne sekcje specyficzne dla projektu. Pamiętaj, że poprzednie sekcje są typowe lub powszechne w pisemnych wnioskach, a nie absolutne wymagania. Zawsze zadawaj sobie pytanie, czego jeszcze mogą potrzebować Twoi odbiorcy, aby zrozumieć projekt, potrzebę jego realizacji, korzyści z niego wynikające, Twoją rolę w nim i Twoje kwalifikacje do jego realizacji. Co jeszcze muszą zobaczyć, aby zatwierdzić projekt i zatwierdzić ciebie do jego realizacji?

Wymagania dotyczące zadań specjalnych

W zależności od sytuacji pisania, twoja propozycja może wymagać również innych specjalistycznych elementów. Niektóre z nich są opisane poniżej. Uwaga: niektóre z tych elementów będą faktycznie wymagane w notatce z postępów w tej klasie; jednak w prawdziwej sytuacji pisania technicznego, przełożony może poprosić o włączenie do propozycji któregoś z poniższych elementów:

Odbiorcy: Opisać publiczność raportu końcowego (który może być inny niż publiczność dla wniosku). Być może trzeba będzie omówić, dla kogo przeznaczony jest raport, ich tytuły i stanowiska, ich zaplecze techniczne i ich zdolność do zrozumienia raportu.

Źródła informacji: Wymień źródła informacji; upewnij się, że wiesz, że są odpowiednie informacje dla twojego tematu; wymień cytaty dla konkretnych książek, artykułów, prac referencyjnych, innych rodzajów źródeł, które twoim zdaniem przyczynią się do twojego raportu.

Grafika: Wymień grafiki, które uważasz, że twój raport będzie potrzebował zgodnie z ich rodzajem i ich treścią. (Jeśli nie możesz wymyślić żadnej grafiki, która będzie potrzebna w twoim raporcie, być może nie masz dobrego tematu – zrób burzę mózgów ze swoim instruktorem). Dla tej klasy, będziesz zobowiązany do stworzenia i włączenia grafiki w swoim raporcie końcowym.

Outline: Dołącz konspekt tematów i podtematów, które uważasz, że poruszysz w swoim raporcie.

Propozycje i publiczność

Pamiętaj, że w kursie pisania technicznego, zadanie propozycji służy kilku celom: (1) daje Ci pewne doświadczenie w pisaniu propozycji; (2) sprawia, że zaczynasz planować swój raport semestralny; (3) daje Twojemu instruktorowi szansę pracy z Tobą nad projektem, aby upewnić się, że masz realny temat. Z drugiego i trzeciego powodu, musisz zawrzeć konkretne elementy w swojej propozycji (jak zaznaczono w arkuszu zadań), z których niektóre mogą nie wydawać się odpowiednie w prawdziwej propozycji.

W tym kursie pisania technicznego, propozycja jest początkiem tygodniowego procesu badań i pisania, który przechodzi przez wiele etapów, aż dojdzie do punktu końcowego: raportu technicznego. Propozycję składasz tylko raz podczas tego procesu. Potem będziesz pisać i składać różne rodzaje dokumentów: raport z postępu prac, konspekt, bibliografię z przypisami, projekt graficzny, projekt raportu i raport końcowy. Uważaj, aby używać terminu „propozycja” tylko wtedy, gdy odnosisz się konkretnie do początkowego etapu swojego projektu.

Inny punkt, o którym należy pamiętać, odnosi się do publiczności dla propozycji w porównaniu z publicznością dla raportów, które pojawiają się później w procesie pisania. Odbiorcą Twojej propozycji jest osoba, która może zatwierdzić, wesprzeć i ewentualnie sfinansować Twoje badania i pracę. Raport końcowy, który sporządzisz, może być skierowany do innej grupy odbiorców. Rozważmy przykład propozycji napisanej do przełożonego w firmie zajmującej się energią słoneczną, sugerującej stworzenie podręcznika polityki dla instalatorów paneli słonecznych w budynkach mieszkalnych. Odbiorcą propozycji może być osoba na stanowisku kierowniczym, której wiedza techniczna może być bardzo szeroka. Z drugiej strony, odbiorcami raportu końcowego są technicy, którzy mogą mieć bardziej specjalistyczną wiedzę niż kadra kierownicza. Treść i język używane dla tych dwóch różnych odbiorców będą musiały być dostosowane do sytuacji pisania. (Aby dowiedzieć się więcej na ten temat, przejrzyj rozdział Analiza publiczności.)

Revision checklist for proposals

As you review and revise your proposal, keep the following in mind:

  • Use the right format. Pamiętaj, że na tych zajęciach piszesz tę propozycję w formacie notatki.
  • Napisz jasne podsumowanie (lub wprowadzenie do) tematu swojej propozycji.
  • Zidentyfikuj dokładnie, co proponujesz zrobić.
  • Zapewnij, że raport – dokument pisemny – jest w jakiś sposób zaangażowany w projekt, który proponujesz zrobić. Pamiętaj, że w tym kursie pisania technicznego zarówno ćwiczymy pisanie propozycji, jak te robione w prawdziwym świecie, jak i kończymy projekt badawczy na poziomie college’u.
  • Upewnij się, że sekcje twojej propozycji są w logicznym, naturalnym porządku i że używasz podtytułów i punktorów (i wszelkich innych stylów formatowania) poprawnie.
  • Adresuj propozycję do nazwanych odbiorców – nie do instruktora.

Informacje o przypisaniu rozdziału

.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.