service manual

คู่มือดิจิตอล

https://guides.service.gov.au/

เรามุ่งมั่นที่จะให้คำแนะนำที่ชัดเจนสอดคล้องและน่าสนใจซึ่งจะสร้างแรงบันดาลใจให้กับทีมและช่วยสนับสนุนพวกเขาด้วยวิธีการออกแบบและให้บริการดิจิทัลที่ยอดเยี่ยม

เอกสารบางส่วน (เลย์เอาต์)

https://govau.github.io/service-manual/docs/

Cuttlebelle Auto-Docs ถูกนำไปใช้กับสาขา gh-pages

ในการอัปเดตเอกสารหลังจากเปลี่ยนหรือเพิ่มบางส่วนให้เปลี่ยนเป็นสาขา gh-pages และเรียกใช้ npm run docs ผลักดันให้ปรับใช้

การทดสอบการถดถอยด้วยภาพ

https://github.com/govau/backstop-guides-tests

สิ่งเหล่านี้สามารถใช้งานได้ก่อนการปรับใช้การผลิตเพื่อดูความแตกต่าง

เป็นการดีสำหรับการเปลี่ยนแปลงที่ไม่สามารถใช้งานได้เพื่อให้แน่ใจว่าไม่มีการถดถอยทางสายตา

สภาพแวดล้อมการจัดเตรียม

• URL : https://service-manual.apps.y.cld.gov.au/
• สาขา : develop
• สถานะ :

สภาพแวดล้อมการทดสอบ (การจัดเตรียมอัตโนมัติ)

• สาขาที่ปรับใช้กับคำต่อท้าย '-Staging' จะถูกนำไปใช้กับสภาพแวดล้อมใหม่
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• ตัวอย่าง test-staging https://service-manual-test-stager.apps.y.cld.gov.au/

การพัฒนา

คำขอดึงทั้งหมดควรเปรียบเทียบกับ develop เพื่อให้สิ่งต่าง ๆ ง่ายขึ้นให้เลือกตัวเลือก Docker แต่ยังมี DIY ก่อนอื่นตรวจสอบที่เก็บ:

 git clone github.com/govau/service-manual
cd service-manual

ตัวเลือกที่ 1: Docker

สร้างภาพนักเทียบท่า:

 service-manual$ docker build -t service-manual .

เรียกใช้ภาพ:

 service-manual$ docker run --rm --volume="$PWD:/workdir" -p 80:8080 -it service-manual

ตอนนี้ชี้เบราว์เซอร์ของคุณไปที่โฮสต์นักเทียบท่าของคุณด้วยบางอย่างเช่น http://localhost/

ตัวเลือกที่ 2: DIY

ขอแนะนำให้คุณติดตั้ง nvm เพื่อจัดการเวอร์ชันโหนดโลคัลของคุณ

เปลี่ยนเวอร์ชันโหนด

nvm use

ติดตั้งการพึ่งพา

npm install

สร้างสินทรัพย์คงที่

npm run build

เริ่มต้นเซิร์ฟเวอร์การพัฒนา

npm run watch

เนื้อหา

เนื้อหาทั้งหมดสำหรับคู่มือบริการอยู่ในโฟลเดอร์ /content เราใช้ Cuttlebelle เป็นเครื่องกำเนิดไซต์แบบคงที่เพื่อแยกเนื้อหาออกจากเค้าโครงอย่างหมดจด

รูปภาพสำหรับหน้าเนื้อหาสามารถเก็บไว้ในโฟลเดอร์ /content/assets

ข้อมูลเมตา

ข้อมูลเมตาสามารถเก็บไว้ในหน้าภายในไฟล์ index.yml ฟิลด์ทั้งหมดยกเว้น pagetitle เป็นตัวเลือก

ทุ่งนา

• pagetitle (string required)
  • ชื่อหน้า
• description (string optional)
  • คำอธิบายเมตา
• keywords (string, comma delimited list, optional)
  • สำหรับเครื่องมือค้นหา
• created_by (string optional)
  • จะปรากฏบนหน้าโดยใช้ intro_with_nav
• published_date (ISO date yyyy-mm-dd optional)
  • จะปรากฏบนหน้าโดยใช้ intro_with_nav
  • ตรวจสอบให้แน่ใจว่าได้ฟอร์มเป็นสตริงเช่น "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • จะปรากฏบนหน้าโดยใช้ intro_with_nav
  • ตรวจสอบให้แน่ใจว่าได้ฟอร์มเป็นสตริงเช่น "2018-05-12"
• boost (integer optional)
  • มีอิทธิพลต่อผลลัพธ์ของเครื่องมือค้นหา
• hidden (boolean optional)
  • ซ่อนหน้าถ้าตั้งค่าเป็นจริง
• weight (integer optional)
  • มีอิทธิพลต่อการสั่งซื้อรายการเมนู

เครื่องมือค้นหา

การค้นหานั้นจัดทำโดยเครื่องมือค้นหา Lunr JavaScript

น้ำหนักในการให้คะแนนการค้นหาอยู่ในลำดับจากมากไปน้อยต่อไปนี้:

1. keywords (boost = 30)
2. title (boost = 10)
3. description (boost = 5)
4. body (ไม่เพิ่ม)

เนื้อหาจะถูกจัดทำดัชนีในเวลาที่สร้างและสามารถได้รับอิทธิพลจาก keywords และ boost ของฟิลด์เมตาดาต้าเสริม

การเพิ่ม

ใช้ค่าเล็ก ๆ เช่น 0.5 - 1 จนกว่าผลการค้นหาที่คุณต้องการจะบรรลุ

คำสำคัญ

คำหลักสามารถเพิ่มในรายการคั่นเครื่องหมายจุลภาค

หน้าสหพันธรัฐ

หน้าภายนอกสามารถสหพันธรัฐได้โดยการเพิ่มข้อมูลลงใน scripts/federate.js

คอมโบพิเศษ

สามารถเพิ่มคำศัพท์พิเศษคำพิเศษสองคำเพื่อปรับปรุงผลลัพธ์สำหรับการสืบค้นที่เฉพาะเจาะจง ตัวอย่างคือบทบาท 'ผู้จัดการการจัดส่ง'

วิธีเพิ่มคอมโบพิเศษ:

1. ผนวกการรวมกันของ function specialCombos(query) ใน 06-search-results.js
2. เพิ่มคำสองคำในคำหลักของหน้า

ค้นหาไฟล์ข้อมูลคงที่

ข้อมูลการค้นหาและดัชนีจะถูกเก็บไว้ในไฟล์คงที่ต่อไปนี้ซึ่งถูกปรับใช้กับไซต์:

1. documents.json (ข้อมูลเอกสารไซต์)
2. pathmap.json (ตารางค้นหาสำหรับ SERP)
3. search_index.json (ดัชนีอนุกรมของ Lunr)

การสร้างดัชนีการค้นหาใหม่ในการพัฒนา

เมื่อทดลองกับการปรับแต่งการค้นหาในการพัฒนาจำเป็นต้องสร้างดัชนีการค้นหาใหม่หลังจากเปลี่ยนเนื้อหาหรือข้อมูลเมตา ซึ่งสามารถทำได้ร้อนในหน้าต่างเทอร์มินัลอื่นที่มี cuttlebelle ทำงาน

 npm run build:search