آیا می خواهید نحوه نوشتن اسناد ساختاریافته با استفاده از DITA XML را یاد بگیرید؟ اگر بله، می توانم کمک کنم!
اسم من جردن استانچف است. من در 20 سال گذشته حرفه خود را در زمینه ارتباطات فنی ایجاد کرده ام.
با شروع بهعنوان یک توسعهدهنده جاوا، به یک نویسنده فنی ارشد تبدیل شدم و به عنوان یک معمار اطلاعات DITA شغلی ایجاد کردم.
من هزاران صفحه راهنمای اسناد نرم افزار را برای مدیران و توسعه دهندگان نوشته ام. محصولات نرم افزاری که من روی آنها کار کرده ام در زمینه امنیت، خدمات پیام رسانی و زیرساخت توسعه (مانند GitHub و SAP NWDI) هستند.
امروز، من بخشی از تیمی هستم که توسعه پروژههای زیرساختی مبتنی بر DITA XML را رهبری میکند. جامعه نویسندگان فنی که ما در خدمت آن هستیم بیش از 1000 نویسنده است. من همچنین ریاست گروه کارشناسان متشکل از نزدیک به 300 نفر گروه قوی معماران اطلاعات DITA در یک شرکت Fortune 100 - SAP SE را بر عهده دارم. من دائماً باید مشخصات توسعه نرم افزار و مستندات پروژه را بنویسم، علاوه بر راهنمای کاربر.
چه می توانم بگویم، من تجربه زیادی برای به اشتراک گذاشتن در نوشتن ساختار یافته و معماری اطلاعات با استفاده از DITA XML دارم. و این چیزی است که در این دوره روی آن تمرکز می کنم.
بر اساس تجربه من، آنچه می توانم به شما بگویم این است که برای یک نویسنده فنی مدرن که به دنبال ایجاد حرفه خود در زمینه ارتباطات فنی است، دانستن DITA XML به سادگی یک امر ضروری است!
باور نمیکنید چقدر از دانشآموزانم میشنوم که چگونه دانش این دوره باعث پیشرفت در مصاحبه شغلی نویسنده فنی DITA آنها شده است و به آنها کمک میکند تا شغلشان را پیش ببرند!
برای رسیدن به هدف نهایی شغلی، تنها چیزی که نیاز دارید یادگیری نوشتن با استفاده از DITA است!
اگر به هر نحوی با اسناد نرم افزاری درگیر هستید، دانش DITA برای شما مرتبط است:
نویسنده فنی؛
معمار اطلاعات؛
مدیر افراد، مدیریت نویسندگان فنی در تیم؛
طراح تجربه کاربر؛
تحلیلگر کسب و کار؛
مدیر پروژه؛
دوره آموزشی "چگونه با استفاده از DITA XML بنویسیم" برای نویسندگان فنی سطح متوسط تا پیشرفته طراحی شده است که می خواهند به قابلیت های ارائه شده توسط DITA عمیق بپردازند، راهنمای کاربر پیچیده و شخصی سازی شده ایجاد کنند و این خروجی تک منبع را با استفاده از آن ارائه دهند. ابزار Oxygen Author به کانال های تحویل مختلف.
این بر اساس آموزش آنلاین DITA XML است که من به دانشجویانم در دانشگاه ارائه داده ام.
هشدار:
فقط گذراندن این مطالب از شروع این دوره حدود 8-10 ساعت طول می کشد! با تمرینات عملی، مثالها و توصیههای زیادی بر اساس تمرین من ارائه میشود.
توصیه میکنم حداکثر یک بخش را در روز مصرف کنید تا از خستگی جلوگیری کنید و هر تمرینی را که توضیح داده شد انجام دهید.
این دوره، مفاهیم و دانش اساسی معرفی شده با دوره "شروع سریع نوشتن فنی با DITA" را بیشتر می کند و سپس جزئیات و استراتژی های پیشرفته تری مانند استفاده مجدد از محتوا و شخصی سازی محتوا بر اساس استراتژی پروفایل را ارائه می دهد. .
توجه:
اگر به دنبال یک شروع سریع در DITA هستید، دوره اولیه DITA "یک شروع سریع برای نوشتن فنی با DITA" را در نظر بگیرید، که برای ارتباطات فنی است که هنوز با DITA آشنایی ندارند.
این دوره چقدر طول می کشد؟ به طور خلاصه:
بخش 1: مقدمه - 70 دقیقه
بخش 2: 5 گام سریع برای نوشتن در DITA XML - 50 دقیقه
بخش 3: عناصر DITA - 25 دقیقه
بخش 4: استفاده مجدد از محتوا در DITA - 50 دقیقه
بخش 5: پروفایل (تهویه) محتوا در DITA - 60 دقیقه
بخش 6: معماری اطلاعات برای ارتباطات فنی - 50 دقیقه
بخش 7: معماری اطلاعات برای نویسندگان DITA - 90 دقیقه
بخش 8: نحوه ایجاد تصاویر تعاملی در DITA - 80 دقیقه
بخش 9: پیوند در DITA - 77 دقیقه
بخش 10: سفارشی کردن خروجی DITA XML - 60 دقیقه
چه چیزی یاد خواهید گرفت؟
بخش 1: مقدمه - 70 دقیقه
در پایان این بخش می توانید توضیح دهید:
- DITA چیست ;
- مزایای نوشتن اسناد نرم افزاری با استفاده از DITA چیست؛
فقط املای مزایای نوشتن در DITA زمان زیادی می برد! دلایل زیادی وجود دارد که چرا DITA بیشتر و بیشتر محبوب می شود. اگر ندانید که چگونه اسناد نرم افزاری را با استفاده از DITA XML بنویسید، امروز نمی توانید یک نویسنده فنی مدرن باشید! این XML استاندارد واقعی برای نوشتن است! شما باید مزایای DITA را بدانید و توضیح دهید، و مطمئن باشید، در یک مصاحبه شغلی از شما سوال می شود که چرا DITA اینقدر مهم است.
فقط به نام چند مورد:
- بر اساس انواع اطلاعات رایج.
- این شامل قوانین سختگیرانه ای برای نوشتن است، مهم نیست نویسنده فنی چه کسی باشد!
- محتوا مدولار شده و قابل استفاده مجدد است.
- خروجی های مختلف به صورت خودکار از یک منبع DITA تولید می شود؛
- محتوا را می توان شخصی کرد، و غیره.
بخش 2: 5 گام سریع برای نوشتن در DITA XML - 50 دقیقه
در پایان این بخش شما قادر خواهید بود:
- 5 مرحله را برای ایجاد محتوای راهنمای کاربر اعمال کنید؛
- توضیح دهید که نقشه DITA چیست ;
- 3 نوع موضوع DITA را که بیشترین استفاده را دارند ایجاد کنید: وظیفه، مفهوم و مرجع؛
- ایجاد نقشه های DITA ;
- ارجاع موضوعات در نقشه برای ساخت یک قابل تحویل (راهنمای کاربر) با استفاده از Oxygen XML Author ;
نوشتن در DITA آسان است. اجازه ندهید تنوع در برچسب ها و تعداد زیادی از قابلیت های DITA شما را گیج کند.
تنها چیزی که برای نوشتن اولین راهنمای خود نیاز دارید یک استراتژی (آنچه می خواهید ارائه دهید) و مجموعه ای از مراحل ساده است که برای ساختن راهنمای خود باید دنبال کنید (در این بخش از دوره توضیح داده شده است)!
بخش 3: عناصر DITA - 25 دقیقه
در پایان این بخش شما قادر خواهید بود:
- متداول ترین عناصر موضوع DITA (برچسب های DITA) را نام ببرید.
- یک استراتژی برای استفاده از عناصر موضوع در زمینه یک موضوع خاص توضیح دهید؛
- عناصر موضوع مورد نیاز را در یک موضوع باز کنید، جستجو کنید و انتخاب کنید؛
- از فهرست عناصر موضوع در زمینه یک موضوع Task استفاده کنید؛
DITA دارای تعداد زیادی برچسب برای استفاده است. با آنها انعطاف پذیری زیادی برای نوشتن محتوا به همراه دارد. اما شما از کجا شروع می کنید؟ و کدام عناصر "باید دانستن" در مقابل "اختیاری برای دانستن" هستند؟ این همان چیزی است که در این بخش یاد خواهید گرفت تا محتوای خود را شروع کنید.
بخش 4: استفاده مجدد از محتوا در DITA - 50 دقیقه
در پایان این بخش شما قادر خواهید بود:
- مزایای استفاده مجدد را شرح دهید؛
- استفاده مجدد از محتوا در سطح نقشه (mapref)؛
- استفاده مجدد از محتوا در سطح موضوع (topicref)؛
- استفاده مجدد از محتوا در سطح عنصر موضوع (conref)؛
- استفاده مجدد از کل ردیف های جدول (conref - conrefend)؛
استفاده مجدد از محتوا در همه این سطوح به شما این امکان را می دهد که زمان صرف نوشتن اسناد را به طور چشمگیری کاهش دهید. این یکی از مهمترین مزایای DITA است.
اجازه بدهید مثالی برای شما بزنم: می توانید از استفاده مجدد در سطح عنصر موضوع برای تعریف نام محصول نرم افزاری خود به عنوان عنصر موضوعی قابل استفاده مجدد استفاده کنید. سپس از این عنصر در کل سند خود استفاده می کنید. بعداً، هنگامی که نام محصول تغییر می کند، مقدار عنصر موضوع قابل استفاده مجدد را به روز می کنید و به طور خودکار در همه موارد در هر سند به روز می شود! این را با زمان جستجو و جایگزینی نام محصول در سند Word یا صفحه ویکی مقایسه کنید!
بخش 5: پروفایل (تهویه) محتوا در DITA - 60 دقیقه
در پایان این بخش شما قادر خواهید بود:
- مزایای استفاده از نمایه سازی در محتوای خود را شرح دهید؛
- محتوای نمایه در سطح نقشه؛
- محتوای نمایه در سطح موضوع؛
- محتوای نمایه در سطح عنصر موضوع؛
- ردیف های جدول نمایه ;
امروزه همه در مورد شخصی سازی تجربه کاربر با نرم افزار صحبت می کنند. در مورد شخصی سازی تجربه کاربر با مستندات نرم افزار چطور؟
عملکرد نمایهسازی به شما امکان میدهد تا محتوا را برای مخاطبان هدف خود شخصیسازی کنید، بدون اینکه در فرآیند نوشتن اختلال ایجاد کنید. راهنمای کاربر نهایی شخصی سازی شده به طور خودکار در پایان بر اساس قوانین تعیین شده توسط نویسنده ایجاد می شود. چیزی که برای هر روش غیر ساختاری نوشتن محتوا در DITA تقریبا غیرممکن است با چند کلیک اتفاق می افتد!
بخش 6: معماری اطلاعات برای ارتباطات فنی - 50 دقیقه
در پایان این بخش می توانید توضیح دهید:
- معماری اطلاعات چیست؟
- معمار اطلاعات کیست؟
- برای تبدیل شدن به یک معمار اطلاعات کارآمد چه چیزی را باید در نظر گرفت؟
از این بخش، ما در حال افزایش ریسک هستیم! این دوره نه تنها برای افرادی است که می خواهند نوشتن در DITA را یاد بگیرند، بلکه برای کسانی از شما که می خواهند در حرفه خود رشد کنند نیز مناسب است. نام سطح بعدی در رایتینگ فنی چیست؟ به آن «معماری اطلاعات» می گویند. اما معماری اطلاعات چیست؟ برای تبدیل شدن به یک معمار اطلاعات، قرار است چه کاری را از امروز شروع کنید؟
این همان چیزی است که در این بخش توضیح داده شده است. معماران اطلاعات دارای دیدگاهی سطح بالاتر، گسترده تر و جامع تر از فرآیند تولید محتوا هستند. دیگر روی جزئیات حریصانه راهنمای یک کاربر متمرکز نیستید. درعوض، به تصویر بزرگ نگاه میکنید، محتوای شما کجا و چگونه سازماندهی شده است و چگونه با تجربه مشتری نهایی مطابقت دارد.
در این بخش، اصول اولیه معماری اطلاعات را یاد می گیرید و دروازه های مرحله بعدی در حرفه خود را به عنوان یک نویسنده فنی باز می کنید.
بخش 7: معماری اطلاعات برای نویسندگان DITA - 90 دقیقه
در پایان این بخش می توانید توضیح دهید:
- نحوه کنترل استفاده از مقادیر پروفایل توسط نویسندگان فنی در محدوده نقشه اختصاصی DITA
- نقشه های طرح موضوع DITA چیست
در این بخش، من به جنبه ای اشاره می کنم که توسط بسیاری از نویسندگان فنی متوجه نشده است. معمولاً این تفاوت بین یک نویسنده فنی و معمار اطلاعات بودن در DITA است. من نحوه استفاده از DITA را برای کنترل اینکه چگونه نویسندگان مختلف میتوانند محتوا را در نقشه شما نمایه کنند، کاهش اشتباهات نمایهسازی و اطمینان از کیفیت بهتر اسناد شخصیسازی شده نهایی را کنترل میکند.
بخش 8: نحوه ایجاد تصاویر تعاملی در DITA - 80 دقیقه
در پایان این بخش شما قادر خواهید بود:
- قوانین استفاده از تصاویر در نوشتن فنی را شرح دهید؛
- ابزارهای مورد استفاده برای ایجاد گرافیک را نام ببرید؛
- گرافیک های تعاملی و نقشه های تصویری در DITA را توضیح دهید؛
- مزایای استفاده از گرافیک های تعاملی را شرح دهید.
- یک نقشه تصویری برای یک تصویر در اسناد خود ایجاد کنید؛
بخش 9: پیوند در DITA - 77 دقیقه
DITA XML دارای عملکرد بسیار خوبی است که می تواند به نویسنده فنی و توسعه دهنده اطلاعات کمک کند تا اسناد را به روشی بهینه سازماندهی کند.
هر نویسنده فنی ماهر به شما می گوید که باید پیوندهایی به محتوای خارجی مانند وب سایت ها ایجاد و درج کنید، اما همچنین برای ارجاع به موضوعات دیگر از نقشه DITA خود، اسناد قابل تحویلی داشته باشید که قابلیت های ناوبری عالی را برای خوانندگان شما فراهم می کند.
اما آیا به این معنی است که باید وقت خود را برای ساخت دستی و سپس حفظ این پیوندها تلف کنید؟ به عنوان یک نویسنده فنی که بر ارائه بهترین اطلاعات ممکن به خوانندگان تمرکز دارد، وقت شما گرانبها است! حفظ لینک ها به جای ارائه دستورالعمل ها و محتوای ارزشمند برای خوانندگان، کاری نیست که باید انجام دهید!
چگونه DITA می تواند در این زمینه به شما کمک کند؟
از اینکه بدانید چه تعداد از نویسندگان فنی حتی نمی دانند که DITA XML از پیوندهای تولید شده به طور خودکار پشتیبانی می کند شگفت زده خواهید شد. تنها کاری که باید انجام دهید این است که گزینه پیوند مورد نظر را فعال کنید و لینک های شما به طور خودکار در خروجی تولید شده ظاهر می شوند!
و حتی بهتر می شود، پیوندها فقط زمانی ظاهر می شوند که یک هدف پیوند معتبر وجود داشته باشد!
چه مزایایی برای شما دارد؟ بدیهی است:
زمان کمتری را برای درج پیوندها تلف می کنید.
شانس کمتری برای داشتن پیوند شکسته در اسناد - منجر به کیفیت محتوای بالاتر!
سازگاری بهتر پیوندها - شما یک استراتژی پیوند را انتخاب میکنید و پیوندها به سبکی ثابت در کل اسناد تحویلی شما ظاهر میشوند.
زمان بیشتری برای تمرکز بر آنچه مهمتر است - ارائه اطلاعات با کیفیت بالا به کاربران نهایی!
این چیزی است که وقتی یاد بگیرید چگونه از پیوند در DITA XML استفاده کنید، به دست خواهید آورد!
در این دوره، موضوعات زیر را پوشش خواهیم داد:
پیوندهای ایجاد شده به صورت دستی
با نحوه ایجاد پیوند به:
آشنا خواهید شدیک وب سایت
یک منبع
موضوع DITA دیگر
بین بخشهای مربوط به یک موضوع!
پیوندهای ایجاد شده به صورت خودکار
نحوه راهاندازی و راهاندازی تولید خودکار پیوندها با استفاده از ویژگی مجموعه-type را خواهید آموخت. شما یاد خواهید گرفت که پیوندهایی از نوع ایجاد کنید:
انتخاب
خانواده
توالی
اینها موضوعاتی هستند که در این بخش به آنها می پردازیم، هر یک از آنها با دموها و تمرین هایی همراه است که می توانید با استفاده از ویرایشگر Oxygen XML Author انجام دهید.
بخش 10: سفارشی کردن خروجی DITA XML - 60 دقیقه
در پایان این بخش، شما قادر خواهید بود:
- ظاهر و ظاهر خروجی HTML خود را بر اساس خروجی HTML از پیش تعریف شده (اما، قابل تنظیم!) پیکربندی کنید
چرا DITA؟
نگارش ساختاریافته در DITA XML یک رشته پیشرفته برای نویسندگان فنی است. شما می توانید نویسندگان زیادی را با مهارت های زبانی و نوشتاری مناسب پیدا کنید. اما از قبل میدانید که نوشتن فنی بسیار بیشتر از متن نوشته شده بدون اشتباه املایی است، اینطور نیست؟
اگر به نویسندگان فنی خود نیاز دارید:
- دستورالعمل های نوشتن شرکت یا صنعت خود را به شدت دنبال کنید ؛
- بتوانید زمان کمتری را برای نگهداری اسناد قدیمی صرف کنید و زمان بیشتری را برای فعالیت های ارزش افزوده برای مشتری صرف کنید؛
- اطلاعاتی را ارائه دهید که میتواند در همه سطوح مورد استفاده مجدد قرار گیرد - کل راهنماها، فصلها، موضوعات، جملات یا حتی کلمات واحد؛
- استاندارد کیفیت محتوای بسیار بالایی را بدون پیوندهای شکسته و محتوای گمشده حفظ کنید؛
- به اندازه نیاز مشتری شما قالب های خروجی مختلف تولید کنید - همه از یک محتوا
- از فراداده برای طبقه بندی محتوای نوشته شده و ارائه آن برای اشکال خودکار مصرف اطلاعات استفاده کنید؛
پس به احتمال زیاد شما در حال ارزیابی DITA به عنوان گزینه ای برای نوشتن هستید.
DITA در حال حاضر همه عملکردهای فهرست شده و حتی بیشتر را ارائه می دهد!
داشتن یک نویسنده فنی که میداند چگونه از DITA استفاده کند، میتواند درها را به روی شما باز کند تا در برخی از بزرگترین شرکتهای IT جهان شروع به کار کنید!
شرکت هایی که از DITA استفاده می کنند
در اینجا فقط چند نام شرکت وجود دارد که اسناد خود را با استفاده از DITA XML می نویسند:
- Apple
- IBM (بالاخره آنها DITA را اختراع کردند!)
- VMware
- SAP SE
و صدها شرکت دیگر که بسیاری از آنها در صنعت فناوری اطلاعات و توسعه نرم افزار هستند!
دانش آموزان چه می گویند؟
"من برای آموزش جامع، تکالیف تمرینی چالش برانگیز، و انواع تکنیک های مورد استفاده برای بهبود و اطلاع رسانی نوشتارم ارزش قائل هستم!"
- دوون اپل، توسعه دهنده وب
" اگر می خواهید بدانید که چگونه با استفاده از DITA بنویسید، بروید و این دوره را بررسی کنید! مدرس توضیحات و آموزش های عالی ارائه می دهد که در عمل واقعا مفید هستند. "
- کارینا دلچوا، نویسنده فنی
"معرفی بسیار خوب و قابل فهم به دنیای نرم افزارهای DITA و XML Author. من این دوره را به همه کسانی که می خواهند به سرعت موضوع را بفهمند و شروع به استفاده از آن کنند، به شدت توصیه می کنم... "
- بوریس، دانشجوی دانشگاه
اگر به دنبال راهی برای پیشرفت در حرفه خود به عنوان یک نویسنده فنی DITA هستید، این دوره شماست! مطمئنم که قبلا فقط با جستجو در گوگل متوجه شده اید که دوره ای مانند این بیش از 1000 دلار هزینه دارد و حداقل یک هفته حضور فیزیکی و/یا آنلاین، هزینه های سفر و ... را نیز پوشش نمی دهد. نیمی از مطالبی که در اینجا ارائه می کنم! به لطف خط مشی Udemy برای ارائه بهترین دورهها به بیشترین تعداد ممکن، ما توانستهایم هزینه را فقط در اینجا در Udemy به 199 دلار کاهش دهیم!
این دوره همچنان با یک بخش تعاملی و اجتماعی همراه است - شما به یک انجمن آموزشی بسته در صفحه فیس بوک JPDocu Learning دسترسی خواهید داشت.
شما این شانس را خواهید داشت که مستقیماً با مربی این دوره تماس بگیرید و بازخورد شخصی در مورد سؤالاتی که ممکن است در مورد استفاده از DITA داشته باشید دریافت کنید.
پس از اتمام موفقیت آمیز این دوره، گواهی ارزشمندی دریافت خواهید کرد که می توانید آن را در رزومه خود قرار دهید، یا در فیس بوک و لینکدین به اشتراک بگذارید - اهمیت این گواهی را دست کم نگیرید - بدون آن، به احتمال زیاد هرگز موفق نخواهید شد آن را در لیست کوتاه برای مصاحبه شغلی شغل رویایی شما قرار داده است!
و شاید مهمترین بخش، که به شما امکان میدهد نه تنها به یک مصاحبه شغلی برسید بلکه از آن عبور کنید - کار خودتان که میتوانید از آن برای نشان دادن آنچه آموختهاید و نحوه استفاده از DITA برای تولید اسناد استفاده کنید!
اکنون ثبت نام کنید و ببینید که نوشتن فنی با DITA XML چقدر ساده و مفید است!
P.S. اگر به دنبال شغلی به عنوان نویسنده فنی در یک شرکت توسعه نرم افزار هستید - 2 مورد را بررسی کنید:
1. آیا آنها اسناد نرم افزاری را با استفاده از DITA XML می نویسند؟
2. از کدام ابزار برای نوشتن استفاده می کنند؟
حتی قبل از مصاحبه شغلی خود آماده باشید تا اسناد DITA XML را که با استفاده از Oxygen XML Author نوشتهاید به نمایش بگذارید و ثابت کنید که چقدر در به کارگیری استراتژیهای استفاده مجدد و تکنیکهای پیشرفته DITA - پروفایل، پیوند خودکار و نقشههای تصویری مهارت دارید.
P.S.S. فراموش نکنید که این دوره با سیاست بازپرداخت کامل 30 روزه ارائه می شود - بدون سوال!
ما مستندات و DITA نرم افزار را آموزش می دهیم! بیش از 8000 دانشجو! یادگیری نوشتن فنی آسان است - پس از همه ، این فقط سند ساده است! JPDocu School of Technical Writing یک شرکت آموزشی است که علاقه زیادی به کمک کاربر ، ارتباطات فنی و تبدیل آن به یک تجربه کاربری مثبت دارد. دوره های آموزش الکترونیکی ما با ارائه تجارب عملی ساده برای پیگیری و عملی با نوشتن فنی ، به ما در شکل گیری نسل بعدی نویسندگان فنی و توسعه دهندگان اطلاعات کمک می کنیم. ماموریت ما امروزه همه در مورد حرفه های آینده صحبت می کنند. مردم می ترسند که برای نیازهای آینده کار آماده نیستند. ما معتقدیم که نباید از تغییر ترس داشت. ما معتقدیم که با آموزش مناسب ، آموزش و تجربه عملی ، مشتریان ما آماده دیدار با آینده با خوشحالی خواهند بود. بهترین راه برای موافقت با این ترس مطالعه و یادگیری است.
نمایش نظرات