Skip to content

Instructional WHAT-WHY framework

The Instructional WHAT-WHY framework is a structural approach used in technical documentation and operating procedures to provide context and clarity.^[400-devops__06-Kubernetes__k8s-paas__Features.md] It requires the author to explicitly state two components for any given task or topic^[400-devops__06-Kubernetes__k8s-paas__Features.md]:

  • WHAT (什么): An explanation of the specific actions being taken or the subject matter being discussed^[400-devops__06-Kubernetes__k8s-paas__Features.md].
  • WHY (为什么): The reasoning behind the actions, explaining the purpose or necessity of the task^[400-devops__06-Kubernetes__k8s-paas__Features.md].

This framework ensures that users are not merely following steps blindly but understand the underlying logic of the operations they are performing^[400-devops__06-Kubernetes__k8s-paas__Features.md].

Sources

^[400-devops__06-Kubernetes__k8s-paas__Features.md]