Technická dokumentace Bc. Lukáš Procházka Téma: závěrečná část dokumentu, dodatky a manuály 1) Závěrečná část dokumentu 2) Dodatky 3) Manuály a návody – obsah dokumentu
Závěrečná část dokumentu Závěrečná část dokumentu je řazena v následujícím pořadí: dokument
analytický list rozdělovník s údaji o dostupnosti dodatky – součást dokumentu zadní deska dodatky – samostatný dokument
i
Pokud mají všechny dodatky pouze velikost formátu A4 (dokumentu) mohou byt součástí dokumentu, pokud mají dodatky jiný formát (např. schémata, výkresy, …) tvoří samostatný dokument (samostatné listy v deskách).
Analytický list - je důležitý z hlediska zpracování informací o dokumentu v automatizovaných rešeršních systémech - umísťuje se za poslední lichou stránku - doporučeno vytvořit jej ve více světových jazycích - obsahuje základní informace o dokumentu: obsah analytického listu název
instituce
abstrakt
datum vydání
autor
ISBN, ISSN
klíčová slova
datum přijetí
atd.
Rozdělovník s údaji o dostupnosti - seznam příjemců dokumentu – DIL (Document Issuing List) - umísťuje se na rubovou stránku zadní desky, nebo na samostatný list - součástí je informace o dostupnosti dokumentu (instituce, která dokument vydává) - případně obsahuje další specifické údaje o příjemcích (adresy, typ médií, …)
Rozdělovník s údaji o dostupnosti - obsahuje údaj o uložení originálu, případně o organizaci zajišťující realizaci dokumentu
Dodatky (Přílohy) - dodatky (přílohy) nejsou povinnou součástí každého dokumentu - obsahují ilustrace, tabulky, schémata, výkresy, podrobné matematické postupy … - do dodatků jsou tyto části zařazeny z důvodu: důvody zařazení do dodatků rozsahu
velikost formátu
stavby textu
- rozsah je příliš velký
- formát je příliš velký
- nezbytná část
- stovky a tisíce listů
- neodpovídá formátu dokumentu
- logická stavba textu
- např. mapy, výkresy, …
- velmi podrobné
- jsou samostatným dokumentem (nejčastěji v deskách), případně součástí dokumentu - pokud je formát shodný s dokumentem mohou být součástí dokumentu (1 vazba) - v tomto případě je vhodné vložit mezi dokument a dodatky barevný list - barevný list slouží ke snazší orientaci v dokumentu (dokument – dodatky)
desky dokumentu
oddělovací stránka dokument dodatky
Označování dodatků - dodatky se označují velkými písmeny abecedy vzestupně (A, B, C, D, …), případně je možné je značit číselně: označení velkými písmeny Dodatek A
nebo
Příloha A
označení číselné Dodatek 3
nebo
Příloha 3
- v celém dokumentu však musí být dodatky (přílohy) značeny stejným způsobem
Označování objektů v dodatcích - objekty v dodatcích se rozumí obrázky, tabulky, grafy, … (viz. hodina 13, 14) - obrázky, tabulky , grafy, … se značí obdobně jako v jádru dokumentu - pro rozlišení se u objektů přidává označení dodatku, do kterého spadají - značení objektů v dodatcích: (např. v dodatku č. 2 nebo označeného písmenem B) 3. obrázek/graf v pořadí v dodatku B (č. 2)
Obrázek B.3 – …
Obrázek 2.3 – …
2. tabulka v pořadí v dodatku B (č. 2)
Tabulka B.2 – …
Tabulka 2.2 – …
5. rovnice v pořadí v dodatku B (č. 2)
(rov. B.5)
(rov. 2.5)
¨
?
Co jsou to dodatky, co obsahují a jakým způsobem se označují objekty, které dodatky dodatcích?
Textové dodatky– příklad A Střední průmyslová škola na Proseku
Pro text, který chcete zobrazit jako titulek stránky ve vyhledávačích (podtržený odkaz) použijte tag
. Tag <title> je párovým tagem, takže musí být ukončen jako všechny párové tagy .
Obr. 11 - tag
použitý v kódu stránky Sami tvůrci webových vyhledávačů přikládají tomuto tagu velikou důležitost, jelikož lidé se ve výsledcích vyhledávání orientují podle textu odkazů. … Vytvořený HTML kód (Příloha 1) je …<br />
<br />
dokument, téma: tvorba webové stránky - celý HTML kód je uveden v dodatcích - v dodatcích kvůli rozsahu (např. 20 stran) - v jádru dokumentu, jsou jen části kódu - části kódu jsou uvedeny jako doplněk textu zdůvodnění umístění HTML kódu do dodatků<br />
<br />
dodatek – tabulka parametrů<br />
<br />
Textové dodatky– příklad B Střední průmyslová škola na Proseku<br />
<br />
Dodatek B – řešení příkladu č. 2<br />
<br />
3.2. Dvojková soustava:<br />
<br />
Dáno: 101001010011001010112<br />
<br />
Dvojkovou soustavou je soustava, která může nabývat pouze hodnot 0 a 1. Užívána je zejména ve výpočetní technice. Všechny výpočty …<br />
<br />
Řešení: 10100101001100101011 = 1x219 + 0x218 + 1x217 +<br />
<br />
… + 0x216 + 0x215 + 1x214 + 0x213 + 1x212 + 0x211 + Příklad 2: Převeďte číslo 1010011001010112 do desítkové soustavy. Výsledek viz. (eq. 6) 101001010011001010112 = XX10<br />
<br />
(eq. 6)<br />
<br />
+ 0x210 x 1x29 + 1x28 + 0x27 + 0x26 + 1x25 + 0x24 + + 1x23 + 0x22 + 1x21 + 1x20 = 1x524288 +<br />
<br />
Úplné řešení příkladu č. 2 viz. Dodatek B. + 0x262144 + 1x131072 + 0x65536 + 0x32768 +<br />
<br />
dokument, téma: rovnice - celý HTML kód je uveden v dodatcích<br />
<br />
+ 1x16384 + 0x8192 + 1x4096 + 0x2048 + 0x1024 + + 1x512 + 1x256 + 0x128 + 0x64 + 1x32 + 0x16 +<br />
<br />
- v dodatcích kvůli rozsahu (např. 20 stran) - v jádru dokumentu, jsou jen části kódu - části kódu jsou uvedeny jako doplněk textu zdůvodnění umístění HTML kódu do dodatků<br />
<br />
+ 1x8 + 0x4 + 1x2 + 1x1 = 67665110<br />
<br />
-1-<br />
<br />
dodatek – úplný výpočet<br />
<br />
Grafické dodatky– příklad A Střední průmyslová škola na Proseku<br />
<br />
Dodatek A<br />
<br />
SPŠ na Proseku<br />
<br />
Navržený řídící program byl vytvořen v grafickém programovacím prostředí (Ladder diagram). Program (Dodatek A) umožňuje ovládání měřícího zařízení ve 3 režimech: automatickém, manuálním a servisním. Automatický režim je určen pro běžný provoz zařízení. Manuální režim je určen pro testování všech funkcí měřícího zařízení. Tento režim může být spuštěn až po dokončení celého cyklu v automatickém režimu. Servisní režim je určen pro manipulaci se zařízením v případě kolizí. …<br />
<br />
dokument, téma: řízení zařízení - celý program je uveden v dodatcích - v dodatcích kvůli rozsahu (např. 50 stran) - v jádru dokumentu, jsou jen části programu - části jsou pak důležité pro pochopení textu zdůvodnění umístění programu do dodatků<br />
<br />
dodatek – PLC program<br />
<br />
2010<br />
<br />
Navržená modernizace konzole frézky FNGJ 20 popsaná v tomto dokumentu je přípravou pro její fyzickou modernizaci. … Uspořádání pohybových mechanismů konzole frézky je zobrazeno v návrhovém výkrese, který je nedílnou součástí tohoto dokumentu (Příloha 1). … Podklady pro výrobu jednotlivých součástí jsou detailně popsány v kap. 5 – Realizace. … Výrobní výkres hřídelů osy X konzole (Příloha 1).<br />
<br />
dokument, téma: rekonstrukce stroje - výkresy jsou standardně v dodatcích - formát výkresu je větší než dokument - jiný typ reprodukce než dokument - výkresy jsou součástí jedné přílohy zdůvodnění umístění do dodatků<br />
<br />
formát dokumentu A4<br />
<br />
Střední průmyslová škola na Proseku<br />
<br />
dodatek – výkresy (vrchní: formát A1, spodní: formát A3)<br />
<br />
Grafické dodatky– příklad B<br />
<br />
formát dokumentu<br />
<br />
A4<br />
<br /> </div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="modal fade" id="report" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<form role="form" method="post" action="https://adoc.pub/report/technicka-dokumentace-bc-luka-prochazka354098dcbf38848bd8d1ec96e11e14ae63223" style="border: none;">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h4 class="modal-title">Report "Technická dokumentace Bc. Lukáš Procházka"</h4>
</div>
<div class="modal-body">
<div class="form-group">
<label>Your name</label>
<input type="text" name="name" required="required" class="form-control" />
</div>
<div class="form-group">
<label>Email</label>
<input type="email" name="email" required="required" class="form-control" />
</div>
<div class="form-group">
<label>Reason</label>
<select name="reason" required="required" class="form-control">
<option value="">-Select Reason-</option>
<option value="pornographic" selected="selected">Pornographic</option>
<option value="defamatory">Defamatory</option>
<option value="illegal">Illegal/Unlawful</option>
<option value="spam">Spam</option>
<option value="others">Other Terms Of Service Violation</option>
<option value="copyright">File a copyright complaint</option>
</select>
</div>
<div class="form-group">
<label>Description</label>
<textarea name="description" required="required" rows="3" class="form-control" style="border: 1px solid #cccccc;"></textarea>
</div>
<div class="form-group">
<div style="display: inline-block;">
<div class="g-recaptcha" data-sitekey="6LcEnMcZAAAAAFHzKKgaE-Qh57XzUTzpfRElD4dP"></div>
</div>
</div>
<script src='https://www.google.com/recaptcha/api.js'></script>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
<button type="submit" class="btn btn-primary">Send</button>
</div>
</form>
</div>
</div>
</div>
<script>
$(document).ready(function () {
var inner_height = $(window).innerHeight() - 250;
$('#pdfviewer').css({"height": inner_height + "px"});
});
</script>
<footer class="footer" style="margin-top: 60px;">
<div class="container-fluid">
Copyright © 2024 ADOC.PUB. All rights reserved.
<div class="pull-right">
<span><a href="https://adoc.pub/about">About Us</a></span> |
<span><a href="https://adoc.pub/privacy">Privacy Policy</a></span> |
<span><a href="https://adoc.pub/term">Terms of Service</a></span> |
<span><a href="https://adoc.pub/copyright">Copyright</a></span> |
<span><a href="https://adoc.pub/contact">Contact Us</a></span> |
<span><a href="https://adoc.pub/cookie_policy">Cookie Policy</a></span>
</div>
</div>
</footer>
<!-- Modal -->
<div class="modal fade" id="login" tabindex="-1" role="dialog" aria-labelledby="myModalLabel">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close" on="tap:login.close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title" id="add-note-label">Sign In</h4>
</div>
<div class="modal-body">
<form action="https://adoc.pub/login" method="post">
<div class="form-group">
<label class="sr-only" for="email">Email</label>
<input class="form-input form-control" type="text" name="email" id="email" value="" placeholder="Email" />
</div>
<div class="form-group">
<label class="sr-only" for="password">Password</label>
<input class="form-input form-control" type="password" name="password" id="password" value="" placeholder="Password" />
</div>
<div class="form-group">
<div class="checkbox">
<label class="form-checkbox">
<input type="checkbox" name="remember" value="1" />
<i class="form-icon"></i> Remember me
</label>
<label class="pull-right"><a href="https://adoc.pub/forgot">Forgot password?</a></label>
</div>
</div>
<button class="btn btn-primary btn-block" type="submit">Sign In</button>
</form>
</div>
</div>
</div>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-177279549-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-177279549-1');
</script>
<script src="https://adoc.pub/assets/js/jquery-ui.min.js"></script>
<link rel="stylesheet" href="https://adoc.pub/assets/css/jquery-ui.css">
<script>
$(function () {
$("#document_search").autocomplete({
source: function (request, response) {
$.ajax({
url: "https://adoc.pub/suggest",
dataType: "json",
data: {
term: request.term
},
success: function (data) {
response(data);
}
});
},
autoFill: true,
select: function( event, ui ) {
$(this).val(ui.item.value);
$(this).parents("form").submit();
}
});
});
</script>
<!-- cookie policy -->
<div id="ADOCPUB_cookie_box" style="z-index:99999; border-top: 1px solid #fefefe; background: #FFC107; width: 100%; position: fixed; padding: 5px 15px; text-align: center; left:0; bottom: 0;">
Our partners will collect data and use cookies for ad personalization and measurement. <a href="https://adoc.pub/cookie_policy" target="_blank">Learn how we and our ad partner Google, collect and use data</a>. <a href="#" class="btn btn-success" onclick="accept_ADOCPUB_cookie_box();return false;">Agree & close</a>
</div>
<script>
function accept_ADOCPUB_cookie_box() {
document.cookie = "ADOCPUB_cookie_box_viewed=1;max-age=15768000;path=/";
hide_ADOCPUB_cookie_box();
}
function hide_ADOCPUB_cookie_box() {
var cb = document.getElementById('ADOCPUB_cookie_box');
if (cb) {
cb.parentElement.removeChild(cb);
}
}
(function () {
var ADOCPUB_cookie_box_viewed = (function (name) {
var matches = document.cookie.match(new RegExp("(?:^|; )" + name.replace(/([\.$?*|{}\(\)\[\]\\\/\+^])/g, '\\$1') + "=([^;]*)"));
return matches ? decodeURIComponent(matches[1]) : undefined;
})('ADOCPUB_cookie_box_viewed');
if (ADOCPUB_cookie_box_viewed) {
hide_ADOCPUB_cookie_box();
}
})();
</script>
<!-- end cookie policy -->
</body>
</html>
