Dokumentacja techniczna i instrukcja obsługi Ge Aeq08

Dokumentacja techniczna i instrukcja obsługi Ge Aeq08 to zestaw wyczerpujących informacji i instrukcji dotyczących urządzenia Aeq08 firmy GE. Zawiera szczegółowe informacje na temat konfiguracji, funkcji i wymagań technicznych, a także zalecenia dotyczące bezpieczeństwa i instrukcje dotyczące instalacji, eksploatacji i konserwacji urządzenia. Dokumentacja techniczna i instrukcja obsługi Ge Aeq08 jest kompleksowym źródłem wiedzy na temat tego urządzenia i pomaga użytkownikom w wykorzystaniu wszystkich funkcji dostępnych w Aeq08.

Ostatnia aktualizacja: Dokumentacja techniczna i instrukcja obsługi Ge Aeq08

Dobra dokumentacja techniczna krok po kroku

Wstęp pełen banałów, które - jak się okazuje - wcale banałami nie są

Mało który programista lubi pisać dokumentację techniczną i niniejszy artykuł nie ma zamiaru przekonywać Cię do tego, że pisanie dokumentacji to najfajniejsze zadanie pod słońcem.

Prosimy Cię tylko o jedno — nie zaczynaj pisać dokumentacji z następującym nastawieniem:`

“Było trudno napisać aplikację,

to niech i trudno będzie ją zrozumieć. ”

Bo przecież dokumentacja techniczna powinna być jak instrukcja obsługi — konkretna, czytelna, rozwiewająca wątpliwości, pokazująca użytkownikowi krok po kroku, gdzie wmontować którą śrubkę oraz jak korzystać ze zmontowanego sprzętu.

A jeżeli już przychylasz się do tej pierwszej prośby, to mamy i drugą: nie odkładaj pisania dokumentacji technicznej “na ostatnią chwilę”. Z tego nigdy nic dobrego nie wychodzi. Po pierwsze, po trzech miesiącach programowania nawet Twój własny kod będzie wyglądał obco. Po drugie, pisana “po łebkach” dokumentacja sprawi tylko, że w kolejnych miesiącach na skrzynce działu technicznego mnożyć będą się mało życzliwe maile od zdenerwowanych programistów, którzy poświęcili godziny swojego czasu na rozwiązaniu jakiegoś problemu i nic ich nie obchodzi, że “u Ciebie wszystko działa”, bo u nich nie działa a z dokumentacją coś jest nie tak.

W zamian, wprowadź w swój tok pracy nad aplikacją dobry nawyk: w każdym tygodniu spędzam 2–4h na tworzenie dokumentacji i jej uaktualnianie. Niech to będzie czas wpisany jasno w harmonogram pracy zespołu.

Krok 1: Zrozumienie, kto tak naprawdę jest odbiorcą dokumentacji, czyli wybór stylu pisania

Istnieją trzy podstawowe sytuacje, gdy ktoś otworzy Twoją dokumentację:

1. Jest ciekawy jak aplikacja działa i co oferuje,
2. Bardzo chce zacząć z niej korzystać,
3. W trakcie korzystania z aplikacji utknął na jakimś etapie i potrzebuje pomocy.

Innymi słowy, na stronie Twojej dokumentacji technicznej wyląduje albo osoba decyzyjna tudzież Project Manager albo — dużo częściej — programista, którego zadaniem jest wdrożenie aplikacji po stronie Klienta.

Dlatego polecamy pisać dokumentację techniczną, tak jakby jej czytelnikami byli programiści.

Co za tym idzie, styl pisania dokumentacji powinien być techniczny i konkretny. Używaj krótkich treściwych zdań bez upiększeń. Całość musi być czytelna już na pierwszy rzut oka i logiczna.

Krok 2: Niezbędne elementy dokumentacji technicznej, czyli tworzenie spisu treści

Każda aplikacja jest inna. Jedna krótsza, druga dłuższa. Stąd niektóre dokumentacje techniczne zajmują dwie strony A4, a inne swoim woluminem przypominają Encyklopedię Britannica. Istnieją jednak podstawowe elementy, które przyjmuje się zawrzeć w każdej dokumentacji technicznej.

Co musi się znaleźć w dokumentacji:

• wstęp, czyli opis sposobu działania (konkretnie: co robi ta appka),
• sposób instalacji aplikacji i zależności,
• zastosowane algorytmy,
• rozmieszczenie i sposoby działania poszczególnych komponentów.

To, co musimy zatem zrobić na wstępie pisania dokumentacji technicznej, to rozrysować jej spis treści. Co, gdzie i w jakiej kolejności, tak żeby każdy istotny element można było łatwo i szybko znaleźć bez względu na to, czy zaglądamy do tej dokumentacji po raz pierwszy, próbując zacząć z niej korzystać czy też wracamy do niej po latach z jakimś bugiem.

Poniżej wrzucamy kilka inspirujących przykładów spisu treści dokumentacji technicznej, które powalają swoją czytelnością i przyjazną dla użytkownika nawigacją.

Przykład 1. Heroku Dev Center

Dokumentacja techniczna Heroku pod względem spisu treści to jeden z najlepszych przykładów na rynku.

Od razu z miejsca widzimy główne kategorie — od architektury przez bazy danych, bezpieczeństwo, linie komend i dodatki aż po języki supportu. Poniżej głównych linków dodatkowo mamy wylistowane w trzech kolumnach wszystkie elementy wchodzące w skład każdej z głównych kategorii. Żadnego rozwijania czy zwijania elementów. Wszystko podane na tacy.

Przykład 2. Laravel

Całkowicie inny układ spisu treści (ale równie wygodny w użyciu) proponuje Laravel.

Główne kategorie zostały wypisane na lewym bocznym pasku strony z dokumentacją, a każdą z kategorii i jej menu otwieramy plusikiem. Podmenu, na którym w danym momencie się znajdujemy, wyróżniono dodatkowo czerwonym kolorem, co ułatwia nawigację.

Krok 3: Opisanie poszczególnych komponentów i zamieszczenie przykładów zastosowania (koniecznie z fragmentami kodu! )

Gdy mamy już uporządkowane menu naszej dokumentacji technicznej, przechodzimy do opisania poszczególnych elementów.

Na początek wstęp, czyli kilka zdań wytłumaczenia do czego służy aplikacja.

Można to zrobić jednym akapitem, opisując podstawowe działanie, tak jak np. Stripe Sigma:

Lub możemy opisać całość jednym prostym zdaniem, np. “Ta aplikacja pozwala uzyskać dostęp do bazy danych YXC, na podstawie których przewidzisz ile prezentów dostaniesz od swoich znajomych w najbliższym roku”.

Następnie przechodzimy do opisania konkretnych metod działania programu oraz zastosowanych komend.

Co ważne, każdą komendę warto podeprzeć przykładem z kodem!

Dlaczego? Uzasadnienie jest proste:

1. przykłady szybciej tłumaczą zasadę działania niż rozległe opisy tekstowe, a skoro czytelnikami naszej dokumentacji technicznej są programiści, z pewnością docenią wklejone fragmenty kodu,
2. przykłady kodu to również gotowe elementy kopiuj-wklej. W ten sposób użytkownicy mogą od razu wykorzystać w praktyce dane linijki bez konieczności rozpracowywania wszystkiego własnym wysiłkiem.

Przydatna wskazówka:

Warto stopniować metody od najłatwiejszej do najtrudniejszej. W ten sposób, dopiero po 3–5 łatwiejszych przykładach (np. test uwierzytelniania czy prosty request) opisujemy metody bardziej skomplikowane. Dzięki temu, programista najpierw zostaje zachęcony sukcesami pierwszych prób, a dopiero później staje przed trudniejszymi wyzwaniami. Łatwiej mu wtedy przetworzyć nowe informacje.

Krok 4: Nie bój się sięgać po przydatne narzędzia, czyli z których generatorów dokumentacji technicznej warto korzystać

Nie zawsze wszystko trzeba robić ręcznie. Nie żyjemy wszak w XVII wieku;) Generator dokumentacji technicznej to nieocenione narzędzie, które automatycznie konwertuje pliki źródłowe za nas i wrzuca je do HTML lub dowolnego innego pliku wyjściowego. Znacznie przyspiesza to tworzenie dokumentacji technicznej.

W ostatnich latach generatorów dokumentacji technicznej pojawia się na rynku coraz więcej i więcej. Tutaj podpowiadamy, które naszym zdaniem są obecnie w zdecydowanej czołówce.

TOP 3 darmowe generatory dokumentacji technicznej, które zapewniają wsparcie dla takich języków programowania jak. m. in. C++, C, Objective-C, C#, PHP, Java, Python i IDL:

• Doxygen,
• Natural Docs,
• Slate.

Z pewnością któryś z nich podbije Twoje serce;)

“Win-Win situation” — wygrywasz i Ty i Twój Klient

• mniej próśb o pomoc techniczną ( rozwiązywanie problemów technicznych trwa zazwyczaj dłużej niż pisanie dokumentacji! ),
• wymiana negatywnych maili na pozytywne (nie psujemy krwi i nastroju Klientom i sami nie podnosimy sobie ciśnienia, czytając zażalenia),
• mamy porządną podwalinę pod rozwój kolejnych produktów (skalowanie i takie tam istotne strategicznie dla rozwoju sprawy),
• zadowoleni Klienci, a zatem więcej poleceń, więcej kontraktów i więcej zysku dla firmy.

Mogą Cię zainteresować też inne artykuły z naszego cyklu Tech Stories:

Szacunkowa maksymalna ilość

I. Specyfikacja cenowo asortymentowa Towarów: Załącznik nr 2 do umowy ramowej nr... Lp. 1. Nazwa asortymentu Rejestrator GSM... Cena jednostkowa netto (zł) Szacunkowa maksymalna ilość Minimalna ilości

Bardziej szczegółowo

Rejestrator objętości MacR6Adaptery (nakładki) do gazomierzy METRIX i INTERGAZ INSTRUKCJA INSTALACJI DO GAZOMIERZA Miejsce zbliżenia lub przyłożenia magnesu WYDANIE: 1. 1 STOSOWANIE DO OPROGRAMOWANIA: 002. 01 Maj 2014 1. Przygotowanie

Instrukcja MM-717 Tarnów 2010Instrukcja MM-717 Tarnów 2010 Przeznaczenie modułu komunikacyjnego MM-717. Moduł komunikacyjny MM-717 służy do realizacji transmisji z wykorzystaniem GPRS pomiędzy systemami nadrzędnymi (systemami SCADA)

REMOTE CONTROLLER RADIO 4PY 500 REMOTE CONTROLLER RADIO INSTRUKCJA OBSŁUGI R SPIS TREŚCI 1. Opis ogólny... 3 2. Opis złączy i elementów sterowania... 3. Montaż... 5. Programowanie odbiornika.... 6. Dodawanie pilotów... 2.

STEROWNIK RADIOWY RXH-1KSTEROWNIK RADIOWY RXH-1K rxh1k_pl 07/14 Sterownik radiowy RXH-1K umożliwia zdalne sterowanie urządzeniami elektrycznymi przy pomocy nadajników radiowych (pilotów). Może współpracować maksymalnie z 40 pilotami. pl/767774-Instrukcja-instalatora. html">INSTRUKCJA INSTALATORA-1- Zakład Elektroniki COMPAS 05-110 Jabłonna ul. Modlińska 17 B tel. (+48 22) 782-43-15 fax. (+48 22) 782-40-64 e-mail: ze@compas. com. pl INSTRUKCJA INSTALATORA MTR 105 STEROWNIK BRAMKI OBROTOWEJ AS 13

TECH-AGRO B ę d z i nTECH-AGRO B ę d z i n SRE - 3 TECH-AGRO Będzin - We 1 - We 2 - We 3 - We 4 - We 5 - We 6 - We 7 - We 8 ZASILANIE WYJŚCIE AWARIA Instrukcja obsługi Będzin, wrzesień 1999 rok Spis treści: 1. Opis ogólny

TECH-AGRO B ę d z i n Instrukcja obsługi Będzin, grudzień 2009 rok Spis treści: 1. Opis ogólny urządzenia... 2 1. Dane techniczne... Obudowa i wygląd zewnętrzny... 3 1. Budowa i działanie... 4

PACK TYXIA 541 et 546PACK 54 et 546 FR EN Notice d installation Installation instructions Instrukcja instalacji NL Installatie-instructies Elementy zestawów Spis treści Zestaw 54 7 Zestaw 546 7 4 5630 5730 / Instalacja pilota

Domofon BZ-1P oraz BZ-2P NOVUMPPH Elektronik-Radbit ul. Gębarzewska 15, 26-600 Radom tel. /fax (48) 363-85-35 www. radbit. pl radbit@radbit. pl Domofon BZ-1P oraz BZ-2P NOVUM BZ-1P NOVUM BZ-2P NOVUM Kasety zostały w całości skonstruowane

inteo Centralis Receiver RTSOdbiornik RTS 9. 5 INSTRUKCJA OBSŁUGI W celu optymalnego wykorzystania możliwości Sterownika Centralis Receiver RTS, prosimy Państwa o dokładne zapoznanie się z niniejszą instrukcją. W przypadku jakichkolwiek

KARTA KATALOGOWA HP500KARTA KATALOGOWA HP500 I. ZASTOSOWANIE Lokalizacja i ochrona osób Lokalizacja zwierząt Lokalizacja pojazdów II. ZAWARTOŚĆ PUDEŁKA Urządzenie wraz z akumulatorem Przewód USB Zasilacz podróżny (ładowarka)

INSTALACJA CZUJKI VIBROINSTALACJA CZUJKI VIBRO AAT Trading Company Sp. z o. o. 02-801 Warszawa, ul. Puławska 431, tel. 22 546 0 546, fax 22 546 0 619 e-mail:aat. warszawa@aat. pl; www. aat. pl VIBRO - Instrukcja instalacji VIBRO

Centrala alarmowa ALOCK-1Centrala alarmowa ALOCK-1 http://www. alarmlock. tv 1. Charakterystyka urządzenia Centrala alarmowa GSM jest urządzeniem umożliwiającym monitorowanie stanów wejść (czujniki otwarcia, czujki ruchu, itp. )

Modem radiowy MR10-NODE-SModem radiowy MR10-NODE-S - instrukcja obsługi - (dokumentacja techniczno-ruchowa) Spis treści 1. Wstęp 2. Wygląd urządzenia 3. Parametry techniczne 4. Parametry konfigurowalne 5. Antena 6. Dioda sygnalizacyjna

INSTRUKCJA MONTAŻU / OBSŁUGIINSTRUKCJA MONTAŻU / OBSŁUGI ZWORY ELEKTROMAGNETYCZNE WPUSZCZANE EL-120, EL-140 EL-350, EL-350S EL-600SL, EL-600TSL, EL-600DSL EL-800SL, EL-800BSL EL-800TSL, EL-800DSL EL-1200SL, EL-1200BSL EL-1200TSL,

• Instrukcje obsługi
• Deklaracje zgodności
• Katalogi techniczne
• Prezentacje i kursy
• Specyfikacja
• Tabele wersji i równoważności

Szukaj tytułu, słowa lub referencji

Podrodziny

499 Znaleziono dokumentów

970075 - BOX-IP METAL ENCLOSURE KIT AC-MAX

Ref: 5223 - ZESTAW AC-MAX 2 DRZWI

Ref: 5224 - ZESTAW 4-DRZWIOWY AC-MAX

PDF (1. 4 MB)

970074 - AC-MAX KIT POWER SUPPLY PWR2D_4D

Ref: 5223 - ZESTAW AC-MAX 2 DRZWI

Ref: 5224 - ZESTAW 4-DRZWIOWY AC-MAX

PDF (3 MB)

970211 - SCHEMA AC-MAX KIT BOX 2D REF. 5223

Ref: 5223 - ZESTAW AC-MAX 2 DRZWI

PDF (81. 7 KB)

970078B-1 - GUIDE-1 INSTALLATION KITS AC-MAX (Es-In-Fr-Al-Pt)

Ref: 5223 - ZESTAW AC-MAX 2 DRZWI

Ref: 5224 - ZESTAW 4-DRZWIOWY AC-MAX

PDF (11. 8 MB)

97902 - Mapping Panel Buttons NEW Amplifier VIDEO DUOX (Esp-En-Fr-De-Po)

Ref: 70708 - CITY PANEL DUOX COLOUR S1 CP 101

PDF (1. 6 MB)

97901 - DIGITAL Cityline-Marine Panels NEW Amplifier DUOX VIDEO Installer Manual (Esp-Eng-Fr-De)

Ref: 7364 - COLOUR DUOX DIGITAL CITY PANEL

PDF (6. 2 MB)

97896 - MEMOVISION CITYLINE DUOX 1-2L 1-2L KIT QUICK START GUIDE - ILOFT O MONITOR (Esp-En-Fr-Al-Po)

Ref: 4909 - KIT MEMOVISION iLOFT PURE DUOX

PDF (6. 3 MB)

97893B - DUOX POWER SUPPLY CONNECTION MODULE Ref. 3244 (Es-In-Fr- Al-Po)

Ref: 3244 - DUOX FILTER

Ref: 3244 - FILTR DUOX 18VDC (Części zamienne)

PDF (695. 6 KB)

97892B - VDS Touch screen SMILE Monitor QUICK GUIDE (Esp-En-Fr-Al-Po)

Ref: 6573 - 7" VDS BASIC SMILE MONITOR DOMINIUM

Ref: 6575 - 7" VDS BASIC SMILE TOUCH MONITOR

Ref: 6576 - 7" VDS BASIC SMILE TOUCH MON. DDA

Ref: 6580 - VDS BASIC SMILE 7 MONITOR DOMINIUM BLACK

Ref: 6573 - MONITOR SMILE 7 "VDS BASIC DOMINIUM (Części zamienne)

PDF (2. doc-download? type=handbook&slug=97891-vds-veo-monitor-quick-guide-esp-en-fr-al-po&lang=pl" target="_blank">97891 - VDS VEO MONITOR QUICK GUIDE (Esp-En-Fr-Al-Po)

Ref: 9401 - COLOUR VDS VEO MONITOR 4, 3"

Ref: 9401 - COLOUR VDS VEO MONITOR 4, 3" DDA

PDF (3. doc-download? type=handbook&slug=97888-hi-line-lynx-panel-qr-manual-es-in-fr-al&lang=pl" target="_blank">97888 - HI-LINE LYNX Panel QR Manual (Es-In-Fr-Al)

Ref: 7480 - HI-LINE LYNX VIDEO PANEL S8

Ref: 7480 - HI-LINE LYNX VIDEO PANEL S8 (Spare Part)

PDF (40. 5 KB)

97887C - WAY KIT with proximity (Esp-En-Fr-Al-Po)

Ref: 1403 - 1/W VIDEO WAY PROX 7" KIT

PDF (2. 1 MB)

• <<
• <
• 1
• 2
• 3
• 4
• 5
• 6
• >
• >>

Nie możesz znaleźć tego, czego szukasz? Daj nam znać, jak możemy Ci pomóc.

Skontaktuj się z nami. ›