แนวทางการเขียน

ส่วนต่อไปนี้จะสรุปแนวทางและหมายเหตุสําหรับการเขียนเอกสารเริ่มต้น

คำ แนะ นำ

ส่วนต่อไปนี้สรุปแนวทางทางเทคนิคการออกแบบและผลลัพธ์สําหรับการเขียนผลงาน

เป้าหมาย

ในขณะที่เราสร้างเอกสารของเราเป็นสิ่งสําคัญที่จะต้องพิจารณาว่าเราช่วยให้ผู้อ่านของเราได้อย่างไร ตกหลุมแห่งความสําเร็จ.

แบรด อับรามส์ นิยาม หลุมแห่งความสําเร็จในปี 2003 เป็น

หลุมแห่งความสําเร็จ: ตรงกันข้ามกับยอดเขายอดเขาหรือการเดินทางข้ามทะเลทรายเพื่อค้นหาชัยชนะผ่านการทดลองมากมาย และเซอร์ไพรส์เราต้องการให้ลูกค้าของเราตกอยู่ในแนวทางปฏิบัติที่ชนะ โดยใช้แพลตฟอร์มและเฟรมเวิร์กของเรา เท่าที่เราทําให้มันง่ายที่จะมีปัญหาเราล้มเหลว

จากเป้าหมายนี้ให้พิจารณาสิ่งต่อไปนี้:

ให้ “ประสบการณ์ที่ไม่มีหน้าผา”
- ช่วยผู้ดูแลระบบและทีมการกํากับดูแลจากส่วนกลางสร้างแบบจําลองการบริการตนเองของการใช้ ชุดระบบอัตโนมัติสําหรับ Power Platform
- อนุญาตให้ผู้ใช้ใช้ประโยชน์จากสภาพแวดล้อมการพัฒนาเพื่อรับมือถ้าสภาพแวดล้อมส่วนกลางไม่พร้อมใช้งาน และพวกเขาต้องการคุณลักษณะก่อนการทดสอบหรือการปรับใช้การใช้งานจริงของ ชุดระบบอัตโนมัติสําหรับ Power Platform
- หารือเกี่ยวกับการใช้งานของสภาพแวดล้อมการทดลองใช้ด้วยการตั้งค่าที่ง่ายดายเพื่อรับมือกับ ชุดระบบอัตโนมัติสําหรับ Power Platform
ให้ช่องทางสําหรับคําติชม ให้ทางเลือกสําหรับลูกค้าในการให้ข้อมูลว่าเราสามารถปรับปรุงอะไรได้บ้าง

ตัวควบคุมแหล่งที่มา

คุณทําเสร็จแล้ว เอกสาร ขั้นตอนในการดาวน์โหลดและพุชการเปลี่ยนแปลงไปยังที่เก็บ GitHub
การเปลี่ยนแปลงใหม่จะถูกผลักไปยังสาขาใหม่และมีคําขอดึงข้อมูลเพื่อตรวจสอบการเปลี่ยนแปลง
เอกสารทั้งหมดควรเป็นมาร์กดาวน์ JSon หรือแอสเซทแบบคงที่ที่สามารถควบคุมเวอร์ชันและตรวจสอบได้โดยใช้กระบวนการขอดึงข้อมูลมาตรฐาน

แนวทางการออกแบบ

โฮมเพจ

มีชื่อและคําบรรยายที่ชัดเจนซึ่งสรุปวัตถุประสงค์ของประสบการณ์เริ่มต้น
แสดงคํากระตุ้นการตัดสินใจเพื่อรวมกิจกรรมอื่นๆ ที่เกี่ยวข้อง ตัวอย่างเช่น ลงทะเบียนสําหรับเวลาทําการ
ลิงก์ไปยังการดําเนินการเริ่มต้นใช้งานเป็นการดําเนินการหลักเพื่อช่วยเหลือผู้ใช้ใหม่ที่พร้อมใช้งาน
การดําเนินการรองเพื่อเข้าร่วมเวลาทําการเพื่อช่วยสร้างชุมชนของผู้ใช้
รวมไทล์ของการกระทําทั่วไป
รายการสรุปของคุณลักษณะที่ช่วยให้ผู้ใช้จัดการโครงการ hyperautomation
การนําทางส่วนท้ายสําหรับลิงก์ทั่วไป

อ่าน การกําหนดค่าไซต์ สําหรับข้อมูลเพิ่มเติมเกี่ยวกับการกําหนดค่าโฮมเพจ

ใช้ซ้ํา

ใช้เค้าโครงฮิวโก้เพื่อให้สามารถระบุธีมใหม่หรือแทนที่ธีมปัจจุบันโดยการวางเนื้อหาในโฟลเดอร์ site\layouts
การเปลี่ยนเลย์เอาต์ควรอนุญาตให้ HTML แบบคงที่รวมอยู่ในตําแหน่งโฮสติ้งหลายแห่ง เช่น
- หน้า GitHub
- หน้าพลังงาน
- แชร์พอยท์
- Azure Static Websites
วิธีการนี้สามารถใช้เป็นเทมเพลตโดยคู่ค้าหรือลูกค้าเพื่อสร้าง “ชุดเอกสาร” เพื่อเร่งขั้นตอน nuture ของ ชุดระบบอัตโนมัติสําหรับ Power Platform เอกสาร
มอบความสามารถสําหรับผู้ใช้เอกสารหลายคน (เช่น ทีมศูนย์ความเป็นเลิศของลูกค้าและคู่ค้า)
อนุญาตให้ผู้ใช้ระบุเนื้อหาที่จะรวม
อนุญาตกระบวนการอัปเกรดที่อนุญาตให้ดึงการเปลี่ยนแปลงใหม่จาก ชุดระบบอัตโนมัติสําหรับ Power Platform เอกสารเริ่มต้น

หน้ามาร์กดาวน์

คุณสามารถใช้ รหัสสตูดิโอภาพ เมื่อต้องการแก้ไขแฟ้ม markdown
ไฟล์ Markdown ควรอยู่ในโฟลเดอร์ /site/content
ไฟล์มาร์กดาวน์แต่ละไฟล์ควรมีส่วนหัวทั่วไปในแต่ละหน้า

title: Sample page
description: Automation Kit sample page
sidebar: false
sidebarlogo: fresh-white
include_footer: true

ไฟล์ Markdown ควรใช้รหัสย่อเพื่อฝัง JavaScript ใด ๆ

รหัสย่อ

โค้ดสั้นให้ความสามารถในการรวมเนื้อหาแบบไดนามิกในหน้ามาร์กดาวน์ คุณสามารถอ่านเพิ่มเติมเกี่ยวกับรหัสย่อได้จาก เอกสารรหัสย่อของ Hugo

โครงการนี้ยังมีรหัสย่อเพิ่มเติม

สารบัญ

เพิ่มปุ่ม ทีโอซี ต่อจากรหัสย่อไปยัง Markdown เพื่อรวมสารบัญของส่วนหัว Markdown ไว้ในหน้าที่ล้อมรอบด้วย {{ และ }}

<toc/>

ปัญหา

รวมชุดคําถามในหน้าเว็บของคุณล้อมรอบด้วย {{ และ }}

<questions name="/content/en-us/foo.json" completed="Thank you for completing foo" showNavigationButtons=false />

พารามิเตอร์:

ชื่อ ชื่อของไฟล์ JSon ที่มีคําถามที่จะนําเข้า อ่าน คำ ถาม สําหรับข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบไฟล์คําถาม
เสร็จ สมบูรณ์ ข้อความที่จะแสดงเมื่อคําถามเสร็จสมบูรณ์
แสดงการนําทางปุ่ม ค่าจริง / เท็จกับรองเท้าปุ่มถัดไป / ย้อนกลับ / การนําทางที่เสร็จสมบูรณ์

ภาพภายนอก

ใส่รูปภาพขนาดจากแหล่งภายนอกในหน้าเว็บที่ล้อมรอบด้วย {{ และ }}

<externalImage src="https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png" size="16x16" text="Construction Icon"/>

พารามิเตอร์:

เอสอาร์ซี เส้นทางต้นทางไปยังรูปภาพที่จะนําเข้า
ขนาด ขนาดเป็นพิกเซลเพื่อปรับขนาดภาพต้นฉบับเป็น
ข้อความ ข้อความแสดงแทนที่จะรวมไว้กับรูปภาพ

หมาย เหตุ

การตั้งค่าหน้า GitHub

ขั้นตอนต่อไปนี้ที่ใช้ในการตั้งค่าหน้า GitHub สําหรับไซต์

ตรวจสอบสาขาเอกสาร
```
git checkout gh-pages
```
ฮิวโก้ขยายมีการติดตั้ง
- คุณยังสามารถติดตั้งด้วยช็อคโกแลตบนหน้าต่าง
```
choco install hugo-extended -confirm
```
เปลี่ยนเป็นโฟลเดอร์ของไซต์
```
cd site
```
ทดสอบการเปลี่ยนแปลงของคุณ
```
hugo serve
```
เมื่อต้องการสร้างไซต์ html แบบคงที่ภายในโฟลเดอร์ไซต์ ให้เรียกใช้คําสั่งต่อไปนี้
```
hugo
```
ผลักดันสาขา gh-pages ของคุณไปที่ GitHub
ตั้งค่าโปรเจ็กต์ GitHub เพื่อเปิดใช้งานเพจ
- ดูการกําหนดค่าแหล่งการประกาศสําหรับไซต์เพจ GitHub ของคุณ - เอกสาร GitHub
- สาขา gh-pages ที่เลือกและโฟลเดอร์ /docs

อัปเดตป้ายรูปภาพโฮมเพจ

เมื่อต้องการกําหนดรูปโฮมเพจเองให้เป็นสถานะ: ป้ายแสดงตัวอย่างสําหรับสาธารณะ ให้ทําดังนี้

โคลน svg-badges repo

git clone https://github.com/anouarhassine/svg-badges.git
cd svg-badges

ติดตั้งโมดูล
```
npm install
```
เริ่มต้นเว็บเซิร์ฟเวอร์เพื่อสร้างป้าย
```
npm run start
```

สร้างป้าย

http://localhost:9000/static/Status-Public%20Preview-Green

ดาวน์โหลดป้าย svg
ใช้ inkscape เพื่อแก้ไข svg ที่มีอยู่และบันทึกผลลัพธ์
อัปโหลดรูปภาพใหม่ไปยังโฟลเดอร์ภาพนิ่ง\รูปภาพ\ภาพประกอบ

เปลี่ยนรูปฮีโร่ config.yaml

params:
    hero:
        image: illustrations/worker-public-preview.svg

คําถามและคําตอบ

ปัญหา ทําไมฮิวโก้ถึงถูกเลือก?

ฮิวโก้ เป็นตัวสร้างไซต์แบบคงที่ยอดนิยมที่อนุญาตให้เนื้อหาของ ชุดระบบอัตโนมัติสําหรับ Power Platform เอกสารเริ่มต้นที่จะแปลงเป็น HTML แบบคงที่ที่สามารถโฮสต์ในเพจ GitHub

ปัญหา ทําไมคุณไม่เลือกเครื่องกําเนิดไฟฟ้าแบบคงที่อื่น ๆ

ทีม Power CAT หลักเคยมีประสบการณ์ในการใช้ฮิวโก้มาก่อน

ปัญหา เหตุใดฟอร์มของ Microsoft จึงไม่ใช้สําหรับคําถาม

จุดมุ่งหมายในการออกแบบอย่างหนึ่งคือการรวมกระบวนการคําถามเข้ากับเนื้อหาโดยตรง

ปัญหา ทําไมต้องใช้หน้า GitHub เพื่อโฮสต์เนื้อหา

ซอร์สโค้ดสําหรับ ชุดระบบอัตโนมัติสําหรับ Power Platform มีอยู่แล้วใน GitHub และการสนับสนุนหน้า GitHub ดั้งเดิมเป็นทางเลือกหนึ่งในตําแหน่งที่จะโฮสต์เนื้อหา

ปัญหา เหตุใดเนื้อหานี้จึงไม่เปิด http://learn.microsoft.com?

เมื่อเนื้อหาเติบโตเต็มที่ตามแนวทางที่นํากลับมาใช้ใหม่ได้โดยทั่วไป อาจย้ายไปที่ https://learn.microsoft.com
เป้าหมายการออกแบบที่สําคัญเปิดใช้งานโดยโฮสติ้ง GitHub
- อนุญาตให้ชุมชนมีส่วนร่วมอย่างแข็งขัน
- กระบวนการส่งเสริม Nuture ของศูนย์ความเป็นเลิศเพื่อให้ลูกค้าและชุมชนคู่ค้าสามารถนําเอกสารกลับมาใช้ใหม่ได้

ปัญหา เหตุใดแนวทางจึงไม่นําไปใช้กับโครงการ Power CAT อื่นๆ

ชุดระบบอัตโนมัติสําหรับ Power Platform กําลังทดลองกับช่องทางของเอกสารนี้เพื่อชมเชยและเชื่อมโยงไปยังที่มีอยู่ของเรา เนื้อหาการเรียนรู้. จากข้อเสนอแนะและผลลัพธ์ของการทดลองนี้เราจะประเมินว่าโครงการที่จัดการโดย Power CAT อื่น ๆ จะใช้แนวทางที่คล้ายกันหรือไม่

ปัญหา ฉันจะดูปัญหาเอกสารที่เปิดอยู่ได้อย่างไร

คุณสามารถเยี่ยมชมของเรา เปิดปัญหาเอกสาร หน้า

ปัญหา ฉันจะเพิ่มคําขอฟีเจอร์เอกสารใหม่ได้อย่างไร

สร้างใหม่ คําขอคุณสมบัติ