Матрица покрытия документацией
Матрица нужна для контроля полноты сайта: функция считается задокументированной только тогда, когда у неё есть пользовательская статья, техническая ссылка на реализацию и проверочный сценарий.
Статусы
| Статус | Значение |
|---|---|
готово |
Статья опубликована и проверена на сайте. |
в работе |
Страница создана, но не завершены примеры или сверка с кодом. |
реестр |
Функция перечислена, но подробная статья ещё не написана. |
не реализовано |
Пункт интерфейса виден, но отключён или не имеет рабочего обработчика. |
Начальная матрица разделов
| Область | Источник фактов | Страница | Статус |
|---|---|---|---|
| Проект и быстрый старт | MainWindow.xaml, AppViewModel |
getting-started.md |
в работе |
| Интерфейс программы | OpenCS/MainWindow.xaml, MainWindow.xaml.cs, CalcTasksTreeVM, FemTreeVM |
reference/interface.md |
готово |
| Наборы усилий | CScore/ForceSet, LoadItem, ShellLoadItem, ForceSetVM, ShellForceSetVM, импортеры и SP20Combinations |
reference/force-sets.md |
готово |
| Модель сечения | CrossSection, MaterialArea, Fiber |
concepts/model.md |
в работе |
| Материалы и СП 63 | Material, MaterialChars, Diagramm, DiagrammType.SP63 |
concepts/materials-and-diagrams.md |
в работе |
| Знаки и единицы | CrossSection, PlateSection, импортеры |
concepts/sign-conventions.md |
в работе |
| Фибровый метод | MaterialArea, GridSplit, Geo |
methods/fiber-method.md |
готово |
| Контурное интегрирование | GreenIntegrator, ContourIntegral |
methods/contour-integration.md |
готово |
| Гибридный путь | CrossSection.IntegralOf |
methods/hybrid-integration.md |
готово |
| Сходимость и точность | GreenIntegrator, GridSplit, решатели CScore |
methods/convergence.md |
готово |
| Стержневая аналогия полосы плиты | CScore/PlateStrip, EquivalentSectionProjectService, EquivalentSectionPage |
methods/plate-strip.md |
в работе |
| Нормативная карта задач | локальный корпус norms, СП 63/16/468/20 |
reference/normative-basis.md |
готово |
| Задачи расчёта | CalcTaskPropsDialog.AvailableKinds, TaskRunner, обработчики |
reference/calculation-tasks.md |
готово |
| Команды интерфейса | MainWindow.xaml |
reference/menu-and-commands.md |
готово |
| Предельные усилия | LimitForceHandlers, решатели CScore |
calculations/limit-forces.md |
в работе |
| Трещины и кривизна | CrackingHandler, CrackWidthHandler |
calculations/cracking.md |
в работе |
| Преднапряжение | PrestressLossHandler, PrestressActions |
calculations/prestress.md |
в работе |
| Оболочки и плиты | Shell*Handler, PlateSection |
calculations/shells.md |
в работе |
| Steel | Steel*Handler, CScore steel |
calculations/steel.md |
в работе |
| Огнестойкость | Fire*Handler, CScore.Fire |
calculations/fire.md |
в работе |
| Кручение | TorsionBemHandler, TorsionFemHandler |
calculations/torsion.md |
в работе |
| ЛИРА и SCAD | импортеры OpenCS/Services, CScore/Import |
import/lira.md, import/scad.md, reference/force-sets.md |
готово |
| DXF и AutoCAD | AcadImporter, DXF VM |
import/dxf-autocad.md |
реестр |
| OpenSees | OpenCS.OpenSees, FemAnalysisExecutor |
calculations/opensees.md |
в работе |
| Отчёты | OpenCS.Reporting, провайдеры |
calculations/reports.md |
реестр |
| Тесты и эталоны | проверочные сценарии и контрольные результаты | verification/index.md |
в работе |
Правило обновления
При добавлении нового Kind, Command или контекстного действия сначала добавляется строка в эту матрицу, затем создаётся статья или явно фиксируется причина, почему отдельная статья не нужна. Перед релизом статус реестр не допускается для реализованных функций.