آموزش نگارش فنی: چگونه یک نمونه کار نوشتن DITA XML بسازیم
Technical Writing: How to Build a DITA XML Writing Portfolio
آیا به دنبال ایده هایی در مورد نحوه نوشتن نمونه کارها DITA XML خود و دعوت به مصاحبه شغلی نویسنده فنی هستید؟ یا به عنوان یک نویسنده فنی، آیا به دنبال حفظ مهارت های خود هستید و کنجکاو هستید که ببینید در DITA چگونه خواهد بود؟
اگر بله، این کلاس برای شما مناسب است!
در اینجا خواهید آموخت:
- نحوه انتخاب یک نرم افزار برای توصیف،
- نحوه نوشتن در مورد آن به روشی که از دستورالعمل های نوشتن DITA XML پیروی می کند،
- نحوه ایجاد خروجی مورد علاقه کاربران نهایی، مانند محتوای PDF به HTML،
- و مهمتر از همه، نحوه به اشتراک گذاشتن نتایج به گونه ای که با رزومه شما مطابقت داشته باشد بدون اینکه فضای زیادی اشغال کند.
اغلب، نویسندگان تکنیکی فاقد بخش فنی مهارت های نوشتاری خود هستند. خیلی اوقات آنها روی قسمت نوشتن و ویرایش (تمرکز روی زبان و تایپ) تمرکز می کنند و فراموش می کنند که ابتدا "فنی" هستند و فقط سپس "نویسنده".
DITA XML راهی عالی برای نشان دادن توانایی فنی شماست. DITA XML مخفف Darvin Information Typing Architecture است و استاندارد واقعی برای نوشتن فنی بر اساس زبان های نشانه گذاری گسترده (XML) در صنعت است. همچنین به دلیل ویژگی های اتوماسیون و قابلیت استفاده مجدد که ارائه می دهد، در شرکت های توسعه نرم افزار بسیار محبوب است.
مدرس این کلاس یک متخصص و صاحب محصول یک DITA CMS است که در یکی از بزرگترین شرکت های توسعه نرم افزار در جهان (SAP SE) استفاده می شود و همچنین ارتباطات فنی را در دانشگاه استراسبورگ تدریس می کند.
تکلیف:
پروژه کلاس شما این است که نمونه کارها نویسندگی خود را برای ارجاع از رزومه خود آماده کنید و در مصاحبه شغلی نویسندگی فنی برنده شوید!
این می‌تواند بر اساس هر نرم‌افزاری باشد که قبلاً می‌شناسید یا شرکتی که می‌خواهید در آن کار کنید، قبلاً ارائه کرده است. مهم نیست که نرم افزار قبلاً مستندات نرم افزاری داشته باشد - شما هنوز خودتان آن را با استفاده از سبک و مهارت خود می نویسید.
شروع با:
1. نرم افزاری را که می خواهید درباره آن بنویسید انتخاب کنید.
2. ابزار نوشتن در DITA XML را انتخاب کنید.
3. وظیفه، مفهوم و موضوعات مرجعی را که می نویسید تعریف کنید.
4. اینها را بنویسید و نتایج خود را نشان دهید!
پیوند خود را با محتوایی که پس از کلاس ایجاد کرده اید، با آپلود در بخش "پروژه شما" به اشتراک بگذارید. اگر سوالی دارید یا به نکات بیشتری نیاز دارید، لطفاً به من بگویید! من خوشحالم که کمک می کنم! در اینجا نمونه‌ای از پروژه نمونه کارها است که من توسعه داده‌ام:
درس ها Lessons
-
اهداف پروژه Project goals
-
طرح پروژه Project plan
-
نسخه ی نمایشی: ایجاد موضوعات Task Demo: creating the Task topics
-
یک مخزن عمومی GitHub ایجاد کنید Create a public GitHub repository
-
محتوای نمونه: نوشتن یک مفهوم حمایتی Sample content: writing a supporting Concept
-
معرفی Introduction
-
محتوای نمونه: نوشتن مراحل Task Sample content: writing the steps of the Task
-
مفروضات و محدودیت ها Assumptions and limitations
-
مفاهیم حمایتی را اضافه کنید Add supporting concepts
-
نسخه ی نمایشی: یک مفهوم DITA ایجاد کنید Demo: create a DITA Concept
-
کدام وظایف برای مستندسازی هستند؟ Which are the Tasks to document?
-
برای موفقیت به چه چیزی نیاز دارید؟ What do you need to succeed?
-
فایل های منبع DITA XML خود را در مخزن به اشتراک بگذارید Share your DITA XML source files in the repository
-
مراحل نصب - دمو Installation steps - demo
-
Oxygen XML Author را نصب کنید Install Oxygen XML Author
-
مرحله 1: نوشتن محتوا Phase 1: writing the content
-
طرح پروژه - کاری که باید انجام دهید Project plan - what you have to do
-
فاز 2: تولید خروجی Phase 2: generate the output
درس ها Lessons
-
مفاهیم حمایتی را اضافه کنید Add supporting concepts
-
نسخه ی نمایشی: یک مفهوم DITA ایجاد کنید Demo: create a DITA Concept
-
مراحل نصب - دمو Installation steps - demo
-
محتوای نمونه: نوشتن مراحل Task Sample content: writing the steps of the Task
-
مرحله 1: نوشتن محتوا Phase 1: writing the content
-
مفروضات و محدودیت ها Assumptions and limitations
-
طرح پروژه Project plan
-
معرفی Introduction
-
فاز 2: تولید خروجی Phase 2: generate the output
-
نسخه ی نمایشی: ایجاد موضوعات Task Demo: creating the Task topics
-
کدام وظایف برای مستندسازی هستند؟ Which are the Tasks to document?
-
فایل های منبع DITA XML خود را در مخزن به اشتراک بگذارید Share your DITA XML source files in the repository
-
یک مخزن عمومی GitHub ایجاد کنید Create a public GitHub repository
-
Oxygen XML Author را نصب کنید Install Oxygen XML Author
-
برای موفقیت به چه چیزی نیاز دارید؟ What do you need to succeed?
-
محتوای نمونه: نوشتن یک مفهوم حمایتی Sample content: writing a supporting Concept
-
اهداف پروژه Project goals
-
طرح پروژه - کاری که باید انجام دهید Project plan - what you have to do
https://donyad.com/d/2a3fc0
JPDocu Services
دانشکده نویسندگی فنی
یادگیری نوشتن فنی آسان است - در نهایت، این فقط یک سند ساده است!
JPDocu School of Technical Writing یک شرکت آموزشی است که مشتاق کمک به کاربر، ارتباطات فنی و تبدیل آن به یک تجربه کاربری مثبت است. دوره های آموزش الکترونیکی ما به ما کمک می کند نسل بعدی نویسندگان فنی و توسعه دهندگان اطلاعات را با ارائه تجربیات عملی و ساده در زمینه نوشتن فنی به آنها شکل دهیم.
ماموریت ما
امروزه همه در مورد حرفه های آینده صحبت می کنند. مردم می ترسند که برای نیازهای آینده کاری آماده نیستند. ما معتقدیم که نباید از تغییر هراس داشت. ما معتقدیم که با آموزش مناسب، آموزش و تجربه عملی، مشتریان ما آماده خواهند بود تا آینده را با خوشحالی ملاقات کنند. بهترین راه برای رفع این ترس، مطالعه و یادگیری است.
مدرسه نویسندگی فنی JPDocu این ترس را به دانش عملی تبدیل می کند و افراد را برای شغل آینده - نویسندگی فنی آماده می کند. آنلاین کردن برنامه های ما به ما این امکان را می دهد که به همه شما در سراسر جهان دسترسی پیدا کنیم!
چشم انداز ما
مدرسه نگارش فنی JPDocu اینجاست تا دوره‌ها و آموزش‌های آموزش الکترونیکی با کیفیت بالا (چه به صورت آنلاین و چه در محل) ارائه دهد که به شما در یادگیری حرفه آینده کمک می‌کند. ما دوره های خود را با استفاده از پلتفرم های آموزشی مختلف و تعامل با دانش آموزان خود به دنیا می آوریم.
نمایش نظرات