ZDS2023 - Documentation BoF.pdf

1、 2023 The Zephyr Project Content made available under CC BY-SA 4.0.Zephyr Documentation BoFZDS 2023Benjamin Cabbenjaminzephyrproject.orgkartben 2023 The Zephyr Project Content made available under CC BY-SA 4.0.Zephyr Documentation S 2023 The Zephyr Project Content made available under CC BY-SA 4.0.D

2、ocumentation Survey May-June 202385+respondents since May 26Promoted through Discord/social media/blogs Probably biased towards a certain crowd 2023 The Zephyr Project Content made available under CC BY-SA 4.0.What it surveyedWhats your role,experience level with embedded development,and with Zephyr

3、 in particular?What do you like/dislike in the Zephyr documentation?What do you feel is missing?How do you consume/search for information?2023 The Zephyr Project Content made available under CC BY-SA 4.0.Common ThemesSearchRelated:“discoverability”(of boards,samples,bindings,)NavigationComprehensive

4、 samples/tutorialsHow-tos/Best practicesPDF?Localization?2023 The Zephyr Project Content made available under CC BY-SA 4.0.The goodUp-to-dateExtensiveHonestLives with the codeLots of“human-written”helpful architecture bitsSamples 2023 The Zephyr Project Content made available under CC BY-SA 4.0.Top

5、pain pointsSearching from Google is brokenSite search is kinda broken too(for some people)Need more tutorials/best practices/detailed how-tosSome boards are better documented than othersFor contributorsBuilding doc locally is not well documented and slowDiagrams are not editable 2023 The Zephyr Proj

6、ect Content made available under CC BY-SA 4.0.Doc infra improvementsDONE and TODO 2023 The Zephyr Project Content made available under CC BY-SA 4.0.Google Search experience“When you enter the documentation from a Google search,you often end up in an older version of the documentation.”Situation shou