Guidedog / 문서 0.2.0

개념을 설명하는 다이어그램¶

질문에 맞는 그림을 고른다. 순서도는 선택, 블록도는 책임, 시퀀스는 순서, 그래프는 관계를 설명한다. 글이 더 직접 답하면 글을 쓴다.

순서도¶

용량이 충분하면 변환한다. 부족하면 호스트가 저장 공간을 준비하고 다시 시도한다. — 그림 3 저장 공간을 빌리거나 늘리기 전에 용량을 확인한다.¶

그림은 확장 단계의 소유자를 밝힌다. 변환 코어가 할당한다고 암시하지 않는다. 이 구분은 계약의 일부다.

그래프 작성¶

.. graphviz::
   :caption: Parsing precedes resolution.
   :alt: The source becomes a tree, then references are resolved.

   digraph pipeline {
     graph [rankdir=LR, bgcolor="transparent"];
     node [shape=box];
     "source" -> "tree" -> "resolved tree";
   }

graphviz, graph, digraph는 내장되어 있다. Guidedog이 Graphviz로 렌더링해 HTML에는 SVG를, PDF에는 그림을 넣는다. 그래프 소스는 같다.

읽기 쉽게 다듬기¶

노드 레이블은 짧게 하고 긴 규칙은 아래에 설명한다. 주 경로는 한 방향으로 두고 돌아오는 간선에 조건을 쓴다. 색 외에 형태와 텍스트도 쓴다. 인쇄물에는 색이 없을 수 있다.

대체 텍스트와 캡션을 제공하고 좁은 브라우저와 PDF에서 확인한다. 작은 글씨여야 들어가는 그림은 둘로 나눈다. 이미지 크기는 이미지, 동영상, 오디오, 다운로드를 참고한다.